# GET Get the customiser text template

Retrieve the customiser's text template: the fixed lines (straight or curved) and, on retained metal, the graphic areas, production artwork, mounting holes and manufacturing rules. Every template length is millimetres of the finished sign. `availability` says whether this customiser may carry a template (`available`, `feature_off`, `unsupported_sign` or `unsupported_sizing`), `sign_kind` is `neon`, `retained_metal` or null, and `offered_sizes` lists the Sizes page sizes the template is offered at, with every size it drops and why, in centimetres and inches as on the sizes resource. `template` is null when the customiser has none. Read-only and safe to retry. Requires `customisers:read`. A 404 problem with code `resource_not_found` means the customiser is not on your API key's store.

- Source URL: https://www.signcustomiser.com/help/api/v3-get-get-the-customiser-text-template/
- Markdown URL: https://www.signcustomiser.com/help/api/v3-get-get-the-customiser-text-template.md
- Group: Customiser text template
- OpenAPI for this group: https://www.signcustomiser.com/help/openapi/customiser-text-template.json
- Method: GET
- Path: /api/v3/customisers/{customiser_id}/text-template
- Auth: Bearer token
- Required scopes: `customisers:read`

## Path parameters

- customiser_id (string, required): The customiser id. Example: 1

## cURL example

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

## Response examples

### 200 GET 200 example 1

```json
{
  "data": {
    "object": "text_template",
    "customiser_id": 42,
    "availability": "available",
    "sign_kind": "neon",
    "template": {
      "key": "9c4b1e7a-2d6f-4a8c-b3e5-7f1d0c9a8b6e",
      "revision": 3,
      "frame": {
        "width_mm": 600,
        "height_mm": 300
      },
      "minimum_letter_height_mm": 40,
      "fields": [
        {
          "id": "fld_abcdefghijklmnop",
          "kind": "text",
          "label": "Your name",
          "default_wording": "OPEN",
          "required": true,
          "max_characters": 20,
          "baseline": {
            "kind": "straight",
            "anchor": {
              "x_mm": 300,
              "y_mm": 200
            },
            "span_mm": 500
          },
          "fit": "letter_height",
          "letter_height": null,
          "edits": {
            "wording": true,
            "font": false,
            "colour": false
          }
        }
      ],
      "structure": null
    },
    "offered_sizes": {
      "presets": [
        {
          "size_id": 7,
          "width_cm": 60,
          "width_in": 23.6220472,
          "authored_units": {
            "width_cm": "centimetres"
          }
        }
      ],
      "custom": {
        "min_width_cm": 60,
        "min_width_in": 23.6220472,
        "max_width_cm": 120,
        "max_width_in": 47.2440945,
        "authored_units": {
          "min_width_cm": "centimetres",
          "max_width_cm": "centimetres"
        }
      },
      "custom_minimum_set": true,
      "dropped": [
        {
          "size_id": 8,
          "width_cm": 150,
          "width_in": 59.0551181,
          "reason": "not_priced",
          "priced_max_cm": 120,
          "priced_max_in": 47.2440945,
          "authored_units": {
            "width_cm": "centimetres",
            "priced_max_cm": "centimetres"
          }
        }
      ]
    }
  },
  "links": {
    "self": "https://web.signcustomiser.com/api/v3/customisers/42/text-template",
    "documentation": "https://www.signcustomiser.com/help/api/"
  },
  "meta": {
    "api_version": "v3",
    "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
  }
}
```

### 403 Insufficient scope

```json
{
  "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"
}
```

### 404 Unknown customiser

```json
{
  "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"
}
```
