Scannable Docs

List folders

Returns the folders in your organisation, by name. Pass parent to list the folders directly inside one folder, or parent=none for those at the top level; leave it out to list every folder. Narrow any of these with type. An API key sees every folder, restricted ones included. An OAuth caller sees the folders their role and permissions allow. Pages by cursor: pass each response’s next_cursor as cursor until it is null.

GET
/v1/folders

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.

type?string

Only folders of this type.

Value in"default""kit_bag""location""vehicle""client""equipment_type""staff"
parent?string

Only the folders directly inside this one, as a folder_… identifier, or none for the folders at the top level. Leave it out to list every folder. A folder of another organisation returns 404.

Response Body

A page of your folders, by name.

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/folders'
Example response
{  "data": [    {      "id": "folder_z7n9dlj7vy13rpj",      "name": "Van 3",      "type": "vehicle",      "parent": {        "id": "folder_zeoaiw6e0bc95bl",        "name": "Queenstown Depot"      },      "restricted": false,      "created_at": "2026-03-02T09:30:00.000Z"    }  ],  "total": 42,  "limit": 20,  "next_cursor": "eyJwb3NpdGlvbiI6eyJjcmVhdGVkQXQiOiIyMDIxLTAyLTI1VDIzOjIzOjI5LjAwMFoiLCJ1aWQiOiJpdXNoOTN4djN4cnN2MWMifSwiZmlsdGVycyI6Imw5Rnc0VlVPN2tyOCJ9"}