Sign in
docs

List documents

Returns documents as a tree structure or flat list. All authenticated users can browse. In tree mode, page and perPage apply to direct children of the selected workspace or prefix; each returned directory includes its descendants. In flat mode, they apply to individual documents.

get/docs

Query parameters

remoteNodestring

name of the remote node

workspacestring

Workspace selector. For list and search APIs, use all, default, or a workspace name. Omitted means all.

prefixstring

Relative document path without extension, for example docs/deploy-guide. Must not start with / or contain ..

Optional document path prefix within the selected workspace

pageinteger

page number of items to fetch (default is 1)

perPageinteger

Number of document entries per page (default 50, max 200)

flatboolean

If true, returns flat list instead of tree

sort'name' | 'type' | 'mtime'

Field to sort by:

  • name: Alphabetically by display name (case-insensitive)
  • type: By node type (dirs vs files), then alphabetically within each group
  • mtime: By last modification time
order'asc' | 'desc'

Sort order. For type: asc=folders first. For mtime: desc=newest first.

Response

List of documents

Changes