Skip to main content
GET
List documents

Authorizations

Authorization
string
header
required

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

Query Parameters

scope
string | null

Filter to one scope; omit for "everything I can see".

category
string | null

Filter to one category; omit for all.

tags
string | null

Filter to docs that have ALL listed tags. Comma-separated.

channel
string<uuid> | null

Filter to one channel (only useful with scope=channel).

folder
string<uuid> | null

Filter to documents directly inside this folder.

root
boolean | null

When true, only documents at the root of their scope (folder_id IS NULL). Ignored when folder is set.

trash
boolean | null

When true, return the caller's Trash (their soft-deleted documents) instead of live ones. Overrides scope/folder/root filters.

limit
integer<int64> | null

Default 50, max 200.

Response

200 - application/json

Documents visible to the caller

categories
string[]
required

Distinct categories across the caller's visible set - drives the category-filter sidebar in the UI.

documents
object[]
required
tags
string[]
required

Distinct tags across the caller's visible set.