Customiser languages

Get a customiser language

Copy page

Retrieve one language of the customiser by its language code. The response is the same resource the list operation returns, including the completeness summary and the most recent AI translation.

GET/api/v3/customisers/{customiser_id}/languages/{language_code}

Get a customiser language

Retrieve one language of the customiser by its language code. The response is the same resource the list operation returns, including the completeness summary and the most recent AI translation. 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 or the language does not exist on the store your API key belongs to — a code that is not a well-formed language tag, a language on another customiser, and a language on another store are all the same 404. 401, 403, and 429 problems behave as on the list operation.

Get a customiser language

Click Send to see the live response.

Overview

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 or the language does not exist on the store your API key belongs to — a code that is not a well-formed language tag, a language on another customiser, and a language on another store are all the same 404. 401, 403, and 429 problems behave as on the list operation.

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

language_codestringpathrequired

The language tag, from the list customiser languages operation.

Example: fr

Get a customiser language

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

{
  "data": {
    "object": "customiser_language",
    "customiser_id": 42,
    "language_code": "fr",
    "source_language_code": "en",
    "display_name": "French",
    "status": "draft",
    "is_default": false,
    "is_authoring": false,
    "translation_summary": {
      "key_count": 184,
      "required_key_count": 96,
      "translated_key_count": 12,
      "retired_key_count": 0,
      "missing_required_key_count": 84,
      "publishable": false
    },
    "ai_translation": null,
    "published_at": null,
    "created_at": "2026-05-04T09:09:00Z",
    "updated_at": "2026-05-04T09:11:20Z"
  },
  "links": {
    "self": "https://web.signcustomiser.com/api/v3/customisers/42/languages/fr",
    "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"
}