# GET Get a customiser setup guide

Returns the setup steps of the Overview page and whether each one is complete, in the order the merchant admin shows them. `dismissed` is true when a merchant hid the guide in the admin. Read-only; requires `customisers:read`. A 404 problem means the customiser is not one of this store's.

- Source URL: https://www.signcustomiser.com/help/api/v3-get-get-a-customiser-setup-guide/
- Markdown URL: https://www.signcustomiser.com/help/api/v3-get-get-a-customiser-setup-guide.md
- Group: Customisers
- OpenAPI for this group: https://www.signcustomiser.com/help/openapi/customisers.json
- Method: GET
- Path: /api/v3/customisers/{customiser_id}/setup-guide
- 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/setup-guide \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN'
```

## Response examples

### 200 GET 200 example 1

```json
{
  "data": {
    "object": "customiser_setup_guide",
    "customiser_id": 42,
    "dismissed": false,
    "all_complete": false,
    "complete_count": 1,
    "total_count": 2,
    "steps": [
      {
        "key": "sizes_pricing",
        "title": "Set your sizes and prices",
        "why": "Shoppers see a price for each size.",
        "complete": true
      },
      {
        "key": "install",
        "title": "Add the customiser to your store",
        "why": "Shoppers cannot find it yet.",
        "complete": false
      }
    ]
  },
  "links": {
    "self": "https://web.signcustomiser.com/api/v3/customisers/42/setup-guide",
    "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.",
  "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"
}
```
