Skip to content
LogoLogo

List Workspace Documents

List Workspace Documents

GET/api/v1/workspaces/{workspace_id}/documents

Returns one cursor-paginated page of active root Document metadata, or archived roots when archived_only=true. Title order is the default; sort selects modified-time order. Text, Project, location, scope, descendant, and archive selectors are applied before pagination; a cursor is valid only for the same selectors and sort. Content is not included; read it through the content operation.

location classifies a Document by structure only: workspace is Documents outside every Project and projects is Documents inside one. It never describes visibility or access; scope remains the audience filter. A nested Document always shares its parent's Project, so it is classified by the same rule.

include_descendants=true returns nested Documents as individual rows instead of roots only, each exactly once, with an ancestors path so a flattened result can show where it lives.

Path Parameters

workspace_idRequired
string <uuid>
Example0198ac5e-f9b7-7000-8000-000000000001

Query Parameters

project_id
string <uuid>

Restrict the page to Documents owned by this Project.

Example0198ac5e-f9b7-7000-8000-000000000001
q
string·min 1·max 200

Match terms across a Document title and extracted text.

scope
string

Restrict the page to one Document visibility scope.

Values
workspaceprojectpublic
archived_only
boolean·default false

Return archived roots for recovery instead of active roots.

location
string

Restrict the page by structural location. workspace returns Documents outside every Project; projects returns Documents that belong to a Project. Omit for both. Cannot be combined with project_id when workspace.

Values
workspaceprojects
sort
string·default title

Page order. title is ascending title (default), updated_desc is most recently modified first and updated_asc is least recently modified first, by each Document's own modification time. Ties break by identifier.

Values
titleupdated_descupdated_asc
include_descendants
boolean·default false

Return nested Documents as individual rows, each once, with their ancestor path.

cursor
string·min 1·max 2048

Opaque continuation cursor returned by the preceding page.

limit
integer·min 1·max 100·default 50

Maximum number of resources to return.

Responses

Authentication · Conventions and errors · API guides · Resource reference