Skip to main content
GET
List knowledge documents

Authorizations

x-token
string
header
required

Query Parameters

parentId
string

Omit to list every document regardless of nesting. Pass "" or "null" to list root documents only, or a document ID to list that folder's contents.

aptletUuid
string

Only documents associated with this board.

aptletInstanceId
string

Only documents linked to this card.

streamId
string

Only 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 list archived documents instead of active ones.

ownerId
string

Only documents created by this user (matches createdBy).

updatedById
string

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

createdFrom
string<date-time>

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

createdTo
string<date-time>

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

updatedFrom
string<date-time>

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

updatedTo
string<date-time>

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

unlinked
boolean

Set true to list only documents with no aptletUuid, aptletInstanceId, or streamId — the knowledge base's own top-level documents ("pane 0"), as opposed to documents that hang off a board, card, or conversation. Cannot be combined with aptletUuid, aptletInstanceId, or streamId.

limit
integer
default:50

A non-numeric value is rejected with 400 rather than silently defaulting. A valid non-integer value (e.g. 10.5) is truncated.

Required range: x <= 200
skip
integer
default:0

A non-numeric or negative value is rejected with 400 rather than silently coercing to 0. A valid non-integer value is truncated.

Required range: x >= 0

Response

Paginated list of knowledge document summaries.

docs
object[]
total
integer
limit
integer
skip
integer