Documents

List a document library's folders

Lists the folders of **one** of a project's two document libraries, A→Z. A folder belongs to a project *and* a library, so `kind` is required — there is no folder that spans both. `documentCount` reflects only the documents the caller may see: the Project-Information audience rule is applied, and folders that are empty *for the caller* are omitted for anyone who cannot manage the project, so a reader never opens a folder to find nothing. Folders are one level deep and **organisational only** — a folder never affects who can see a document. Use a returned `id` as `folderId` when listing documents or registering a new one.

GET
/projects/{id}/folders

Lists the folders of one of a project's two document libraries, A→Z. A folder belongs to a project and a library, so kind is required — there is no folder that spans both.

documentCount reflects only the documents the caller may see: the Project-Information audience rule is applied, and folders that are empty for the caller are omitted for anyone who cannot manage the project, so a reader never opens a folder to find nothing.

Folders are one level deep and organisational only — a folder never affects who can see a document. Use a returned id as folderId when listing documents or registering a new one.

Authorization

x-api-key<token>

The per-tenant API key, copied from Settings → API & integrations. Sent as the x-api-key request header. The key is tenant-scoped and acts with Admin-equivalent, tenant-wide access.

In: header

Path Parameters

id*string

Resource id.

Query Parameters

kind*string

Which library's folders to list.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/folders?kind=ohs"
{  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",      "kind": "ohs",      "name": "string",      "documentCount": 0    }  ]}
{  "error": {    "code": "unauthorized",    "message": "Missing or invalid API key."  }}
{  "error": {    "code": "read_only",    "message": "Your subscription is inactive. This action is read-only."  }}
{  "error": {    "code": "not_found",    "message": "Not found."  }}
{  "error": {    "code": "validation",    "message": "One or more inputs are invalid.",    "fields": {      "fieldName": "A message explaining what's wrong with this field."    }  }}