Knowledge

List knowledge documents

Lists knowledge documents scoped to your company — a folder's contents, or everything linked to a board, card, or conversation — in a lite shape (no rendered HTML), paginated.

Access is scoped per-user when authenticated with a delegate token; API keys and partner tokens see every document in the company regardless of its private-doc shares.

get/api/knowledge/list

Request

Query parameters

parentIdstring

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.

aptletUuidstring

Only documents associated with this board.

aptletInstanceIdstring

Only documents linked to this card.

streamIdstring

Only documents extracted from this conversation.

searchstring

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

archivedboolean

Set true to list archived documents instead of active ones.

ownerIdstring

Only documents created by this user (matches createdBy).

updatedByIdstring

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

createdFromstring date-time

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

createdTostring date-time

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

updatedFromstring date-time

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

updatedTostring date-time

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

unlinkedboolean

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.

limitinteger

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

skipinteger

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

Response

Paginated list of knowledge document summaries.

totalinteger
limitinteger
skipinteger

Changes

No recorded changes to this operation across all 1 revision of this API.