Customiser colour scheme

Get the customiser colour scheme

Copy page

Retrieve the colours the customer customiser is drawn in, as one document: the main colours (primary_colour, secondary_colour, text_colour, background_colour), the price and discount colours, the modal, control bar and save form colours, and the colours of the live preview (visualisation_background_colour, visualisation_text_colour).

GET/api/v3/customisers/{customiser_id}/colour-scheme

Get the customiser colour scheme

Retrieve the colours the customer customiser is drawn in, as one document: the main colours (`primary_colour`, `secondary_colour`, `text_colour`, `background_colour`), the price and discount colours, the modal, control bar and save form colours, and the colours of the live preview (`visualisation_background_colour`, `visualisation_text_colour`). Each value is a hex colour, or null when the customer customiser uses its built-in default for that colour. A customiser that has never saved a colour scheme reads every colour as null with `updated_at` null; the read does not create one. 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. A 401 problem means the key is missing, invalid, or expired; a 403 problem with code `insufficient_scope` means the key 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` and a `request_id` to quote when contacting support.

Get the customiser colour scheme

Click Send to see the live response.

Overview

Each value is a hex colour, or null when the customer customiser uses its built-in default for that colour. A customiser that has never saved a colour scheme reads every colour as null with updated_at null; the read does not create one. 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. A 401 problem means the key is missing, invalid, or expired; a 403 problem with code insufficient_scope means the key 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 and a request_id to quote when contacting support.

Authorisation

Bearer token required. Include it in the Authorization header.

Required scope: customisers:read

Path parameters

customiser_idstringpathrequired

The customiser id, from the list customisers operation.

Example: 1

Get the customiser colour scheme

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

{
  "data": {
    "object": "colour_scheme",
    "customiser_id": 42,
    "background_colour": "#1f2937",
    "box_colour": "#ffffff",
    "box_text_colour": "#f97316",
    "button_text_colour": "#0ea5e9",
    "control_bar_background_colour": "#1f2937",
    "control_bar_button_border_colour": "#ffffff",
    "control_bar_button_colour": "#f97316",
    "control_bar_button_hover_colour": "#0ea5e9",
    "control_bar_icon_colour": "#1f2937",
    "discount_price_colour": "#ffffff",
    "form_error_colour": "#f97316",
    "link_colour": "#0ea5e9",
    "main_discount_price_colour": "#1f2937",
    "main_price_colour": "#ffffff",
    "measurement_display_colour": "#f97316",
    "modal_background_colour": "#0ea5e9",
    "modal_overlay_colour": "#1f2937",
    "modal_text_colour": "#ffffff",
    "outline_colour": "#f97316",
    "pending_colour": "#0ea5e9",
    "price_colour": "#1f2937",
    "price_label_colour": "#ffffff",
    "primary_colour": "#f97316",
    "save_form_background_colour": "#0ea5e9",
    "save_form_border_colour": "#1f2937",
    "save_form_button_colour": "#ffffff",
    "save_form_button_text_colour": "#f97316",
    "save_form_heading_colour": "#0ea5e9",
    "save_form_text_colour": "#1f2937",
    "secondary_background_colour": "#ffffff",
    "secondary_colour": "#f97316",
    "secondary_text_colour": "#0ea5e9",
    "selection_number_background_colour": "#1f2937",
    "selection_number_text_colour": "#ffffff",
    "success_colour": "#f97316",
    "text_colour": "#0ea5e9",
    "text_input_background_colour": "#1f2937",
    "visualisation_background_colour": "#ffffff",
    "visualisation_text_colour": "#f97316",
    "updated_at": "2026-05-04T09:12:31Z"
  },
  "links": {
    "self": "https://web.signcustomiser.com/api/v3/customisers/42/colour-scheme",
    "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/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"
}