Sign Customiser

Navigation

Dark mode

Lists the share links shoppers made for designs from the authenticated Store's customisers, newest first in the order they were made (their id order). Requires shares:read.

GET/api/v3/shares
GETList shares
GET/api/v3/shares

List shares

Lists the share links shoppers made for designs from the authenticated Store's customisers, newest first in the order they were made (their `id` order). Requires `shares:read`. Follow `links.next` while `pagination.has_more` is true, sending each cursor back unchanged with the same filters and `timezone`. The filters match the merchant admin's Shares page. `filter[customiser_name]` finds shares whose customiser name contains the text, ignoring case and surrounding spaces. `filter[sign_category]` keeps shares from customisers of that sign category. `filter[created_from]` and `filter[created_to]` are inclusive calendar days, counted in `timezone` (UTC when it is absent).

Authorisation

The Authorization header expects a Bearer token. Generate one on the API keys page in your dashboard.

Query parameters

Page size from 1 to 100. Defaults to 20.

The opaque next_cursor from a previous page.

Only return shares from this customiser.

Only return shares whose customiser name contains this text, ignoring case. At most 255 characters.

Only return shares from customisers of this `sign_category`.

Earliest day to include, inclusive, as YYYY-MM-DD in `timezone`.

Latest day to include, inclusive, as YYYY-MM-DD in `timezone`. Must not be earlier than filter[created_from].

The IANA timezone the created days are counted in. Defaults to `UTC`.

List shares

Click Send to see the live response.

Overview

Follow links.next while pagination.has_more is true, sending each cursor back unchanged with the same filters and timezone. The filters match the merchant admin's Shares page. filter[customiser_name] finds shares whose customiser name contains the text, ignoring case and surrounding spaces. filter[sign_category] keeps shares from customisers of that sign category. filter[created_from] and filter[created_to] are inclusive calendar days, counted in timezone (UTC when it is absent).

Authorisation

Bearer token required. Include it in the Authorization header.

Required scope: shares:read

Query parameters

limitstringquery

Page size from 1 to 100. Defaults to 20.

Example: 20

cursorstringquery

The opaque next_cursor from a previous page.

Example: eyJ2IjoxfQ

filter[customiser_id]stringquery

Only return shares from this customiser.

Example: 42

filter[customiser_name]stringquery

Only return shares whose customiser name contains this text, ignoring case. At most 255 characters.

Example: neon

filter[sign_category]stringquery

Only return shares from customisers of this `sign_category`.

Example: neon

filter[created_from]stringquery

Earliest day to include, inclusive, as YYYY-MM-DD in `timezone`.

Example: 2026-07-01

filter[created_to]stringquery

Latest day to include, inclusive, as YYYY-MM-DD in `timezone`. Must not be earlier than filter[created_from].

Example: 2026-07-31

timezonestringquery

The IANA timezone the created days are counted in. Defaults to `UTC`.

Example: Australia/Sydney

List shares
curl https://web.signcustomiser.com/api/v3/shares?limit=20&cursor=eyJ2IjoxfQ&filter%5Bcustomiser_id%5D=42&filter%5Bcustomiser_name%5D=neon&filter%5Bsign_category%5D=neon&filter%5Bcreated_from%5D=2026-07-01&filter%5Bcreated_to%5D=2026-07-31&timezone=Australia%2FSydney \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN'
Response
{
  "data": [
    {
      "object": "share",
      "id": 512,
      "customiser_id": 42,
      "customiser_name": "Neon signs",
      "image_url": "https://cdn.example.com/customisers/42/product.png",
      "created_at": "2026-07-18T03:14:15Z"
    }
  ],
  "pagination": {
    "has_more": false,
    "next_cursor": null
  },
  "links": {
    "self": "https://web.signcustomiser.com/api/v3/shares",
    "documentation": "https://www.signcustomiser.com/help/api/",
    "next": null
  },
  "meta": {
    "api_version": "v3",
    "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
  }
}

Type a question and press Enter. Use the arrow keys to move between the results.