Sign Customiser

Customiser letter parts

List letter-part colour selections

Copy page

Lists the letter type's materialised letter-part colour selections. A part the letter type lists in letter_parts but that has never been created is absent here rather than invented, so the list is what exists rather than what could exist.

GET/api/v3/customisers/{customiser_id}/letter-types/{letter_type_id}/letter-parts

Overview

Requires customisers:read. The operation is read-only and always safe to retry.

Authorisation

Bearer token required. Include it in theAuthorization header.

Required scope: customisers:read

Path parameters

customiser_idstringpathrequired

The customiser id.

Example: 1

letter_type_idstringpathrequired

The letter type id.

Example: 7

List letter-part colour selections
curl https://web.signcustomiser.com/api/v3/customisers/1/letter-types/7/letter-parts \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN'
Response
{
  "data": [
    {
      "object": "letter_part_colour_selection",
      "customiser_id": 42,
      "letter_type_id": 7,
      "letter_part": "face",
      "name": null,
      "description": null,
      "optional": null,
      "optional_label": null,
      "optional_default_none": false,
      "lightsource": false,
      "custom_image": false,
      "show_default_upload_image": true,
      "show_in_text_editor": true,
      "text_enabled": false,
      "default_upload_image_url": null,
      "created_at": "2026-08-13T00:00:00Z",
      "updated_at": "2026-08-13T00:00:00Z"
    }
  ],
  "pagination": {
    "has_more": false,
    "next_cursor": null
  },
  "links": {
    "self": "https://web.signcustomiser.com/api/v3/customisers/42/letter-types/7/letter-parts",
    "documentation": "https://www.signcustomiser.com/help/api/",
    "next": null
  },
  "meta": {
    "api_version": "v3",
    "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
  }
}