docs

List documents

Returns documents as a tree structure or flat list. All authenticated users can browse.

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. For document target APIs, use default or a workspace name; omitted means default.

pageinteger

page number of items to fetch (default is 1)

perPageinteger

number of items per page (default is 30, max is 100)

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