Scannable Docs
API referenceChecklists

Retrieve a checklist

Returns one of your organisation’s checklists, with its checks in order.

GET
/v1/checklists/{checklist_id}

Authorization

ApiKey
headerAuthorizationBearer <token>

Your organisation's API key. Send it as Authorization: Bearer <key>. Create one in the Scannable admin under Settings → API keys.

Path Parameters

checklist_id*string

The chk_… identifier of one of your checklists.

Response Body

The requested checklist.

application/json
  1. response
id*string

The checklist identifier you use to address it in the API.

name*string

The name of the checklist.

description*|

What the checklist is for, if described.

published*boolean

Whether the checklist is published for inspectors to use.

created_at*string

When the checklist was created (ISO 8601).

updated_at*string

When the checklist or any of its checks last changed (ISO 8601).

criteria*array<>

The checks on the checklist, in order.

Example Request
curl -X GET 'https://api.scannable.io/v1/checklists/chk_zsged1q41baxq7s'
Example response
{  "id": "chk_zsged1q41baxq7s",  "name": "Harness inspection",  "description": "Pre-use and periodic checks for full-body harnesses.",  "published": true,  "created_at": "2025-01-09T12:00:00.000Z",  "updated_at": "2026-02-14T16:20:00.000Z",  "criteria": [    {      "title": "Webbing free of cuts",      "description": "Check the full length, including under buckles.",      "order": 1    }  ]}