# GET Get the Customiser Links settings

Returns the settings of the Store's Customiser Links pages: whether they are on, the Back to Store address, the background colour and the logo. A Store that has never saved the page reads as disabled with no branding. Requires the `store:read` scope.

- Source URL: https://www.signcustomiser.com/help/api/v3-get-get-the-customiser-links-settings/
- Markdown URL: https://www.signcustomiser.com/help/api/v3-get-get-the-customiser-links-settings.md
- Group: Stores
- OpenAPI for this group: https://www.signcustomiser.com/help/openapi/stores.json
- Method: GET
- Path: /api/v3/stores/me/customiser-links
- Auth: Bearer token
- Required scopes: `store:read`

## cURL example

```bash
curl https://web.signcustomiser.com/api/v3/stores/me/customiser-links \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN'
```

## Response examples

### 200 Customiser Links settings

```json
{
  "data": {
    "object": "customiser_links",
    "enabled": true,
    "return_url": "https://demosigns.example",
    "theme_colour": "#FFFFFF",
    "logo_url": "https://cdn.signcustomiser.com/files/8a1d4c2e.png",
    "updated_at": "2026-11-02T09:30:00Z"
  },
  "links": {
    "self": "https://web.signcustomiser.com/api/v3/stores/me/customiser-links",
    "documentation": "https://www.signcustomiser.com/help/api/"
  },
  "meta": {
    "api_version": "v3",
    "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
  }
}
```

### 401 Missing API key

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

### 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 store:read scope.",
  "required_scopes": [
    "store:read"
  ],
  "granted_scopes": [
    "pricing:read"
  ],
  "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}
```

### 429 Rate limited

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