Sign Customiser

Customiser backboards

List backboards

Copy page

Lists the customiser's backboard options in the order the storefront presents them (sort_order, then id). base_price is integer minor units of currency; price_per_sq_cm is a decimal major-unit rate, the same units the pricing document uses. Image fields and the whole geometry object are read-only.

GET/api/v3/customisers/{customiser_id}/backboards

Overview

Requires customisers:read. Follow links.next while pagination.has_more is true, sending each cursor back unchanged. 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, from the list customisers operation.

Example: 1

Query parameters

limitstringquery

Page size from 1 to 100. Defaults to 20.

Example: 20

List backboards
curl https://web.signcustomiser.com/api/v3/customisers/1/backboards?limit=20&cursor= \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN'
Response200
{
  "data": [
    {
      "object": "backboard",
      "id": 11,
      "customiser_id": 42,
      "name": "Clear Acrylic Panel",
      "description": null,
      "backboard_type": "board",
      "letter_type_ids": [
        3
      ],
      "outline_size": null,
      "allow_multilayer": false,
      "custom_background_enabled": false,
      "show_custom_background": false,
      "base_price": 0,
      "currency": "USD",
      "price_multiplier": 1,
      "price_multiplier_target": "base_letter_price",
      "price_per_sq_cm": null,
      "sort_order": 1,
      "image_url": null,
      "button_image_url": null,
      "geometry": {
        "has_custom_shape": false,
        "status": null,
        "failure_reason": null,
        "measured_at": 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/backboards",
    "documentation": "https://www.signcustomiser.com/help/api/",
    "next": null
  },
  "meta": {
    "api_version": "v3",
    "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
  }
}
Response401
{
  "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.",
  "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}
Response403
{
  "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.",
  "required_scopes": [
    "customisers:read"
  ],
  "granted_scopes": [
    "store:read"
  ],
  "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}
Response404
{
  "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"
}
Response422
{
  "type": "https://www.signcustomiser.com/help/api/problems/invalid_parameter",
  "title": "Invalid query parameter",
  "status": 422,
  "code": "invalid_parameter",
  "detail": "The limit parameter must be an integer between 1 and 100.",
  "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}
Response429
{
  "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.",
  "retry_after": 60,
  "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}