Sign Customiser

Customiser backlights

Get a backlight

Copy page

Returns one backlight of the customiser. Requires customisers:read and is safe to retry.

GET/api/v3/customisers/{customiser_id}/backlights/{backlight_id}

Overview

A backlight belonging to another customiser or another store is indistinguishable from an unknown id, and a colour of the main colour selection is never reachable here.

Authorisation

Bearer token required. Include it in theAuthorization header.

Required scope: customisers:read

Path parameters

customiser_idstringpathrequired

The customiser id.

Example: 1

backlight_idstringpathrequired

The backlight id, from the list backlights operation.

Example: 14

Get a backlight
curl https://web.signcustomiser.com/api/v3/customisers/1/backlights/14 \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN'
Response
{
  "data": {
    "object": "backlight",
    "id": 14,
    "customiser_id": 42,
    "name": "Warm White Glow",
    "description": null,
    "colour_type": "single",
    "hexcode": "#FFEEDD",
    "multi_colour_hexcodes": null,
    "texture": "flat",
    "min_width_cm": null,
    "min_height_cm": null,
    "min_size_rule": "any",
    "base_price": 0,
    "currency": "USD",
    "price_multiplier": 1,
    "price_multiplier_target": "base_letter_price",
    "sort_order": 1,
    "image_url": null,
    "example_image_url": null,
    "texture_image_url": null,
    "created_at": "2026-08-13T00:00:00Z",
    "updated_at": "2026-08-13T00:00:00Z"
  },
  "links": {
    "self": "https://web.signcustomiser.com/api/v3/customisers/42/backlights/14",
    "documentation": "https://www.signcustomiser.com/help/api/"
  },
  "meta": {
    "api_version": "v3",
    "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
  }
}