Customiser settings

Get customiser settings

Copy page

Retrieve the customiser's settings as one canonical document. The properties fall into five groups.

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

Get customiser settings

Retrieve the customiser's settings as one canonical document. The properties fall into five groups. Feature switches are booleans that turn behaviour on and off (`custom_sizing`, `multi_colour`, `multi_font`, `text_editor_enabled`, `snap_to_grid_enabled`, the `generate_*` vector exports, and the rest). Limits are whole numbers (`min_sign_char`, `max_sign_char`, `max_sign_lines`, `measurement_decimal`, `snap_to_grid_size_px`, `discount_amount` in integer minor units of `currency`). Existing dimension fields carry centimetres with a `_cm` suffix (`min_sign_width_cm`, `initial_sign_height_cm`, `max_sign_length_cm`, `custom_letter_height_max_cm`, `icon_min_height_cm`). Stores with `public_api_dual_quantities` also receive `_in` twins and per-field `authored_units`. `mobile_preview_height_percent` is the one percentage. Presentation choices are closed sets published in product language, never internal spellings — a stored value outside a published set reads back as null. `custom_css` is the merchant's stylesheet for the storefront customiser, and `selection_order` is the ordered list of option steps, each naming its option `family`, its `label`, and whether it is `hidden`. A customiser whose settings have never been saved reads every property back as null; the first merge patch creates the row. 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 customiser settings

Click Send to see the live response.

Overview

Feature switches are booleans that turn behaviour on and off (custom_sizing, multi_colour, multi_font, text_editor_enabled, snap_to_grid_enabled, the generate_* vector exports, and the rest). Limits are whole numbers (min_sign_char, max_sign_char, max_sign_lines, measurement_decimal, snap_to_grid_size_px, discount_amount in integer minor units of currency). Existing dimension fields carry centimetres with a _cm suffix (min_sign_width_cm, initial_sign_height_cm, max_sign_length_cm, custom_letter_height_max_cm, icon_min_height_cm). Stores with public_api_dual_quantities also receive _in twins and per-field authored_units. mobile_preview_height_percent is the one percentage. Presentation choices are closed sets published in product language, never internal spellings — a stored value outside a published set reads back as null. custom_css is the merchant's stylesheet for the storefront customiser, and selection_order is the ordered list of option steps, each naming its option family, its label, and whether it is hidden. A customiser whose settings have never been saved reads every property back as null; the first merge patch creates the row. 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 customiser settings

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

{
  "data": {
    "object": "customiser_settings",
    "customiser_id": 42,
    "currency": "USD",
    "add_to_cart": true,
    "alignment": "show_alignment_options",
    "allow_unsupported_characters": true,
    "app_mode": "standard",
    "auto_process_ai_quotes": true,
    "auto_rotate_lightbox": true,
    "block_emojis": false,
    "braille_dots_use_face_colour": true,
    "braille_table": "en-ueb-g1",
    "cart_action": "cart_page",
    "cart_letter_height_display": true,
    "cart_measurement_display": "both",
    "custom_css": ".sc-price { font-weight: 600; }",
    "custom_letter_height_input": true,
    "custom_letter_height_max_cm": 30,
    "custom_size_input": "when_selected",
    "custom_sizing": true,
    "custom_sizing_max_width_cm": 200,
    "custom_sizing_title": "Custom size",
    "desktop_option_order": "right",
    "desktop_show_sidebar_price": true,
    "disable_braille_untranslatable_popup": true,
    "disable_size_limit_popup": true,
    "discount_amount": 500,
    "discount_option": "none",
    "discount_percentage": 10,
    "drag_enabled": true,
    "etsy_listing_url": null,
    "etsy_show_price": true,
    "example_hover": true,
    "fixed_visualiser": true,
    "font_display": "dropdown",
    "font_scale": 1,
    "generate_ai": true,
    "generate_dxf": true,
    "generate_eps": true,
    "generate_svg": true,
    "glow_effect": "white_neon",
    "glow_switch": "glow_switch",
    "icon_font_tier_id": 3,
    "icon_length_pricing_id": null,
    "icon_min_height_cm": 5,
    "initial_sign_height_cm": 20,
    "initial_sign_length_cm": 60,
    "initial_sign_width_cm": 60,
    "letter_height_display": true,
    "local_cache_enabled": true,
    "manually_clear_loading": true,
    "max_sign_char": 40,
    "max_sign_height_cm": 90,
    "max_sign_length_cm": 300,
    "max_sign_lines": 3,
    "max_sign_width_cm": 200,
    "measurement_decimal": 1,
    "measurement_display": "both",
    "measurement_unit": "both",
    "min_sign_char": 1,
    "min_sign_height_cm": 10,
    "min_sign_length_cm": 10,
    "min_sign_width_cm": 20,
    "mobile_preview_height_percent": 45,
    "mobile_view": "stacked",
    "mounting_colour_location": "separate",
    "multi_colour": true,
    "multi_font": true,
    "part_measurement_display": "show",
    "prevent_size_up": true,
    "pricebox_position": "bottom",
    "primary_cart_button": "add_to_cart",
    "recessed_borders": true,
    "rotate_enabled": true,
    "scale_enabled": true,
    "scale_text_with_size": true,
    "scrollable_mobile_options": true,
    "selection_order": [
      {
        "family": "size",
        "label": "Size",
        "hidden": false
      },
      {
        "family": "colour",
        "label": "Colour",
        "hidden": false
      }
    ],
    "share_location": "disabled",
    "show_buy_now_button": false,
    "show_currency": "show",
    "show_custom_size_button": true,
    "show_day_switch": true,
    "show_glow_switch": true,
    "show_initial_mobile_screen": true,
    "show_menu_steps": true,
    "show_menu_steps_first": true,
    "show_real_size_view": true,
    "show_selection_numbers": true,
    "size_display": "all",
    "snap_to_grid_enabled": true,
    "snap_to_grid_size_px": 10,
    "support_colour_location": "separate",
    "taxable_product": true,
    "text_editor_enabled": true,
    "text_orientation_column_direction": "right_to_left",
    "text_orientation_default": "horizontal",
    "text_orientation_mode": "horizontal_only",
    "text_price_start": true,
    "ui_controls_location": "visualiser",
    "zoom_controls_display": "show",
    "updated_at": "2026-05-04T09:12:31Z"
  },
  "links": {
    "self": "https://web.signcustomiser.com/api/v3/customisers/42/settings",
    "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"
}