Skip to main content
GET
List folders

Authorizations

Authorization
string
header
required

Personal Access Token. Send as Authorization: Bearer hq_pat_....

Query Parameters

scope
string | null

Filter to one scope (private / team / channel); omit for all.

trash
boolean | null

When true, return the caller's trashed folders (the top of each trashed subtree) instead of live ones - the Trash view. Overrides scope.

Response

200 - application/json

Folders visible to the caller

created_at
string<date-time>
required
doc_count
integer<int64>
required

Live documents directly in this folder.

id
string<uuid>
required
is_owner
boolean
required
name
string
required
owner_user_id
string<uuid>
required
scope
string
required
updated_at
string<date-time>
required
channel_id
string<uuid> | null
channel_name
string | null
parent_id
string<uuid> | null