Skip to main content
GET
Get the knowledge document tree

Authorizations

x-token
string
header
required

Query Parameters

parentId
string

Omit, or pass "" / "null", for the root level.

depth
integer
default:1

How many levels to expand eagerly.

Required range: x <= 3
aptletUuid
string

Only match documents associated with this board.

aptletInstanceId
string

Only match documents linked to this card.

streamId
string

Only match documents extracted from this conversation.

Case-insensitive substring match on document name. Regex metacharacters are escaped before being interpolated into the query, so the match is always literal.

archived
boolean

Set true to match archived documents instead of active ones. Also widens tree traversal itself so archived documents (and their archived descendants) are reachable at all.

ownerId
string

Only match documents created by this user (matches createdBy).

updatedById
string

Only match documents last updated by this user (matches updatedBy).

createdFrom
string<date-time>

Only match documents created on or after this ISO date (inclusive).

createdTo
string<date-time>

Only match documents created on or before this ISO date (inclusive).

updatedFrom
string<date-time>

Only match documents last updated on or after this ISO date (inclusive). Filters updatedAt only, never createdAt.

updatedTo
string<date-time>

Only match documents last updated on or before this ISO date (inclusive). Filters updatedAt only, never createdAt.

unlinked
boolean

Set true to match only documents with no aptletUuid, aptletInstanceId, or streamId — the knowledge base's own top-level documents ("pane 0"). Cannot be combined with aptletUuid, aptletInstanceId, or streamId.

Response

Tree of knowledge document nodes.

nodes
object[]