Scannable Docs
API referenceChecklists

List checklists

Returns your organisation’s checklists by name. Narrow them with published. Pass each response’s next_cursor as cursor to fetch the next page, until it is null.

GET
/v1/checklists

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.

Query Parameters

limit?integer

Page size (1–100). Defaults to 20.

Range1 <= value <= 100
Default20
cursor?string

The next_cursor of the previous page. Leave it out for the first page. A cursor only works with the filters it was issued for.

published?boolean

Send true for the published checklists only, or false for the unpublished ones. Omit it for both.

Response Body

A page of your checklists.

application/json
  1. response
data*array<>
total*integer

The total number of results that match the filters.

Range-9007199254740991 <= value <= 9007199254740991
limit*integer

The page size applied to this response.

Range-9007199254740991 <= value <= 9007199254740991
next_cursor*|

Pass as cursor to fetch the next page. Null on the last page.

Example Request
curl -X GET 'https://api.scannable.io/v1/checklists'
Example response
{  "data": [    {      "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"    }  ],  "total": 42,  "limit": 20,  "next_cursor": "eyJwb3NpdGlvbiI6eyJjcmVhdGVkQXQiOiIyMDIxLTAyLTI1VDIzOjIzOjI5LjAwMFoiLCJ1aWQiOiJpdXNoOTN4djN4cnN2MWMifSwiZmlsdGVycyI6Imw5Rnc0VlVPN2tyOCJ9"}