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.
Request
- Base URLhttps://core-api.getaptly.com
- Auth
- API key in header x-token
- or API key in header Authorization
- or HTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
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.
Only documents associated with this board.
Only documents linked to this card.
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.
Set true to list archived documents instead of active ones.
Only documents created by this user (matches createdBy).
Only documents last updated by this user (matches updatedBy).
Only documents created on or after this ISO date (inclusive).
Only documents created on or before this ISO date (inclusive).
Only documents last updated on or after this ISO date (inclusive). Filters updatedAt only, never createdAt.
Only documents last updated on or before this ISO date (inclusive). Filters updatedAt only, never createdAt.
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.
A non-numeric value is rejected with 400 rather than silently defaulting. A valid non-integer value (e.g. 10.5) is truncated.
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.
Changes
No recorded changes to this operation across all 1 revision of this API.