Sign Customiser

Navigation

Dark mode

Returns one share link made for a design from the authenticated Store's customisers. Requires shares:read. A share of another Store answers the same 404 as one that never existed.

GET/api/v3/shares/{share_id}
GETRetrieve a share
GET/api/v3/shares/{share_id}

Retrieve a share

Returns one share link made for a design from the authenticated Store's customisers. Requires `shares:read`. A share of another Store answers the same 404 as one that never existed.

Authorisation

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

Path

The share id, from the list shares operation.

Retrieve a share

Click Send to see the live response.

Authorisation

Bearer token required. Include it in the Authorization header.

Required scope: shares:read

Path parameters

share_idstringpathrequired

The share id, from the list shares operation.

Example: 512

Retrieve a share
curl https://web.signcustomiser.com/api/v3/shares/512 \
  --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"
  },
  "links": {
    "self": "https://web.signcustomiser.com/api/v3/shares/512",
    "documentation": "https://www.signcustomiser.com/help/api/"
  },
  "meta": {
    "api_version": "v3",
    "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
  }
}

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