Scannable Docs

Retrieve a folder

Returns one folder in your organisation, with the members and teams that have a permission on it. An API key can read a restricted folder. An OAuth caller can read it only with access to it.

GET
/v1/folders/{folder_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

folder_id*string

The folder_… identifier of a folder in your organisation.

Response Body

The requested folder.

application/json
  1. response
id*string

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

name*string

The name of the folder.

type*string

What the folder is: a kit bag, a location, a vehicle and so on.

Value in"default""kit_bag""location""vehicle""client""equipment_type""staff"
parent*|

The folder this one sits in, or null for a folder at the top level.

restricted*boolean

Whether Managers and Members need a permission to see the folder. True when this folder or any folder above it is restricted.

created_at*string

When the folder was created (ISO 8601).

permissions*array<>

The members and teams with a permission on this folder, whether set on it or inherited from a folder above, up to the nearest restricted one. Users and Suppliers see a folder only through a permission; Managers and Members need one when the folder is restricted. Admins see every folder and are not listed.

Example Request
curl -X GET 'https://api.scannable.io/v1/folders/folder_z7n9dlj7vy13rpj'
Example response
{  "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",  "permissions": [    {      "member": {        "id": "member_0shacc5ppeye6v5",        "name": "Mere Walker"      },      "team": {        "id": "team_1mw8uo1xpt48tc2",        "name": "Rope Access Crew"      },      "source": "explicit",      "from_folder_id": "folder_zeoaiw6e0bc95bl"    }  ]}