---
title: "List knowledge documents"
method: GET
path: "/api/knowledge/list"
tags: ["Knowledge"]
---

# List knowledge documents

`GET /api/knowledge/list`

## Request

- Base URL: `https://core-api.getaptly.com`
- URL: `https://core-api.getaptly.com/api/knowledge/list`
- Auth: one of:
  - API key in header `x-token`
  - API key in header `Authorization`
  - HTTP bearer
- TypeScript: <https://skmtc.dev/getaptly/apis/aptly-api/docs/api/knowledge/list/get.ts> (a function with typed inputs; its response is checked against the schema)

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.

## Query parameters

- `parentId` string
- `aptletUuid` string
- `aptletInstanceId` string
- `streamId` string
- `search` string
- `archived` boolean
- `ownerId` string
- `updatedById` string
- `createdFrom` string, date-time
- `createdTo` string, date-time
- `updatedFrom` string, date-time
- `updatedTo` string, date-time
- `unlinked` boolean
- `limit` integer
- `skip` integer

## Response `200`

Paginated list of knowledge document summaries.

- object
  - `docs` KnowledgeDocSummary[]
    - `_id` string: Document ID.
    - `name` string: Document title.
    - `emoji` string, nullable
    - `iconUrl` string, nullable
    - `accessType` 'public' | 'publicReadonly' | 'private'
    - `parentId` string, nullable: Parent document ID, or null for a root document.
    - `rank` integer, nullable: Sort order among siblings. May be null.
    - `archived` boolean
  - `total` integer
  - `limit` integer
  - `skip` integer

## Other responses

- `400`: Invalid input — an unparseable date, `to` not after `from`, `unlinked=true` combined with `aptletUuid`/`aptletInstanceId`/`streamId`, or a non-numeric `limit`/`skip` (or a negative `skip`).
- `401`: Invalid or missing API key.

---

[API](https://skmtc.dev/getaptly/apis/aptly-api.md) - [All operations](https://skmtc.dev/getaptly/apis/aptly-api/llms.txt) - [OpenAPI document](https://skmtc.dev/getaptly/apis/aptly-api/revisions/75c367e0b8e5?raw)