Customisers

Get a customiser

Copy page

Retrieve one customiser by its integer id (as returned by the list operation). The response reports the customiser's pricing model (simple_letter, advanced_letter or frame_fit, with a human display name), its sign_category and product_family, its styling selection_mode, and whether it is active on the storefront.

GET/api/v3/customisers/{customiser_id}

Get a customiser

Retrieve one customiser by its integer `id` (as returned by the list operation). The response reports the customiser's pricing model (`simple_letter`, `advanced_letter` or `frame_fit`, with a human display name), its `sign_category` and `product_family`, its styling `selection_mode`, and whether it is `active` on the storefront. The operation is read-only, has no side effects, and is always safe to retry. Requires the `customisers:read` scope. A 404 problem with code `resource_not_found` means the customiser does not exist on the store your API key belongs to — use the list operation to discover valid ids; ids from another store are indistinguishable from unknown ids. A 401 problem means the key is missing, invalid, or expired. A 403 problem with code `insufficient_scope` means the key is valid but lacks `customisers:read`. A 429 problem means too many requests: wait `retry_after` seconds, then retry. Error responses use RFC 9457 problem+json with a machine-readable `code`, a documentation link in `type`, and a `request_id` to quote when contacting support.

Get a customiser

Click Send to see the live response.

Overview

The operation is read-only, has no side effects, and is always safe to retry. Requires the customisers:read scope. A 404 problem with code resource_not_found means the customiser does not exist on the store your API key belongs to — use the list operation to discover valid ids; ids from another store are indistinguishable from unknown ids. A 401 problem means the key is missing, invalid, or expired. A 403 problem with code insufficient_scope means the key is valid but lacks customisers:read. A 429 problem means too many requests: wait retry_after seconds, then retry. Error responses use RFC 9457 problem+json with a machine-readable code, a documentation link in type, and a request_id to quote when contacting support.

Authorisation

Bearer token required. Include it in theAuthorization header.

Required scope: customisers:read

Path parameters

customiser_idstringpathrequired

The customiser id, from the list operation.

Example: 1

Get a customiser

curl https://web.signcustomiser.com/api/v3/customisers/1 \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN'

{
  "data": {
    "object": "customiser",
    "id": 42,
    "name": "Neon sign builder",
    "active": true,
    "pricing_model": "simple_letter",
    "pricing_model_display_name": "Simple Letter",
    "sign_category": "neon",
    "product_family": "neon",
    "selection_mode": "single_style",
    "created_at": "2026-01-12T03:14:15Z",
    "updated_at": "2026-06-01T22:09:41Z"
  },
  "links": {
    "self": "https://web.signcustomiser.com/api/v3/customisers/42",
    "documentation": "https://www.signcustomiser.com/help/api/"
  },
  "meta": {
    "api_version": "v3",
    "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
  }
}

{
  "type": "https://www.signcustomiser.com/help/api/problems/missing_api_key",
  "title": "Missing API key",
  "status": 401,
  "code": "missing_api_key",
  "detail": "Provide a store API key as a bearer token: Authorization: Bearer <api key>. Keys are created in the merchant admin under Integrate → API Tokens.",
  "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}

{
  "type": "https://www.signcustomiser.com/help/api/problems/insufficient_scope",
  "title": "Insufficient scope",
  "status": 403,
  "code": "insufficient_scope",
  "detail": "This operation requires the customisers:read scope, but the API key grants the following scopes: store:read. Create a key that includes the required scope in the merchant admin under Integrate → API Tokens.",
  "required_scopes": [
    "customisers:read"
  ],
  "granted_scopes": [
    "store:read"
  ],
  "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}

{
  "type": "https://www.signcustomiser.com/help/api/problems/resource_not_found",
  "title": "Resource not found",
  "status": 404,
  "code": "resource_not_found",
  "detail": "The requested resource does not exist or does not belong to the authenticated store.",
  "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}

{
  "type": "https://www.signcustomiser.com/help/api/problems/unknown_parameter",
  "title": "Unknown query parameter",
  "status": 422,
  "code": "unknown_parameter",
  "detail": "The request includes query parameters this endpoint does not support: include. This endpoint accepts no query parameters.",
  "errors": [
    {
      "parameter": "include",
      "code": "unknown_parameter",
      "detail": "The query parameter \"include\" is not supported by this endpoint."
    }
  ],
  "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}

{
  "type": "https://www.signcustomiser.com/help/api/problems/rate_limited",
  "title": "Too many requests",
  "status": 429,
  "code": "rate_limited",
  "detail": "You have exceeded the request limit for this API key. Wait 60 seconds, then retry.",
  "retry_after": 60,
  "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}