> ## Documentation Index
> Fetch the complete documentation index at: https://docs.getaptly.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 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.




## OpenAPI

````yaml /openapi.yaml get /api/knowledge/list
openapi: 3.0.3
info:
  title: Aptly API
  version: '1.0'
  description: |
    The Aptly API lets external systems work with boards, contacts, inboxes,
    tasks, files, and other Aptly resources.

    Most endpoints accept an API key in the `x-token` header. Some endpoints
    also accept a delegate token or partner bearer token, as shown in each
    operation's security requirements, and explicitly public endpoints require
    no credential. API keys are scoped to a company and may be restricted to
    specific boards and read, insert, or update permissions; requests outside
    those restrictions receive a 403 `FORBIDDEN` response.
servers:
  - url: https://core-api.getaptly.com
    description: Production
security:
  - ApiKeyHeader: []
paths:
  /api/knowledge/list:
    get:
      tags:
        - Knowledge
      summary: List knowledge documents
      description: >
        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.
      operationId: listKnowledgeDocs
      parameters:
        - name: parentId
          in: query
          schema:
            type: string
          description: >
            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.
        - name: aptletUuid
          in: query
          schema:
            type: string
          description: Only documents associated with this board.
        - name: aptletInstanceId
          in: query
          schema:
            type: string
          description: Only documents linked to this card.
        - name: streamId
          in: query
          schema:
            type: string
          description: Only documents extracted from this conversation.
        - name: search
          in: query
          schema:
            type: string
          description: >
            Case-insensitive substring match on document name. Regex
            metacharacters are escaped before being interpolated into the query,
            so the match is always literal.
        - name: archived
          in: query
          schema:
            type: boolean
          description: Set true to list archived documents instead of active ones.
        - name: ownerId
          in: query
          schema:
            type: string
          description: Only documents created by this user (matches `createdBy`).
        - name: updatedById
          in: query
          schema:
            type: string
          description: Only documents last updated by this user (matches `updatedBy`).
        - name: createdFrom
          in: query
          schema:
            type: string
            format: date-time
          description: Only documents created on or after this ISO date (inclusive).
        - name: createdTo
          in: query
          schema:
            type: string
            format: date-time
          description: Only documents created on or before this ISO date (inclusive).
        - name: updatedFrom
          in: query
          schema:
            type: string
            format: date-time
          description: >
            Only documents last updated on or after this ISO date (inclusive).
            Filters `updatedAt` only, never `createdAt`.
        - name: updatedTo
          in: query
          schema:
            type: string
            format: date-time
          description: >
            Only documents last updated on or before this ISO date (inclusive).
            Filters `updatedAt` only, never `createdAt`.
        - name: unlinked
          in: query
          schema:
            type: boolean
          description: >
            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`.
        - name: limit
          in: query
          schema:
            type: integer
            default: 50
            maximum: 200
          description: >
            A non-numeric value is rejected with 400 rather than silently
            defaulting. A valid non-integer value (e.g. 10.5) is truncated.
        - name: skip
          in: query
          schema:
            type: integer
            default: 0
            minimum: 0
          description: >
            A non-numeric or negative value is rejected with 400 rather than
            silently coercing to 0. A valid non-integer value is truncated.
      responses:
        '200':
          description: Paginated list of knowledge document summaries.
          content:
            application/json:
              schema:
                type: object
                properties:
                  docs:
                    type: array
                    items:
                      $ref: '#/components/schemas/KnowledgeDocSummary'
                  total:
                    type: integer
                  limit:
                    type: integer
                  skip:
                    type: integer
        '400':
          description: >
            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`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Invalid or missing API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - ApiKeyHeader: []
        - DelegateToken: []
        - PartnerBearer: []
components:
  schemas:
    KnowledgeDocSummary:
      type: object
      description: >-
        Lite shape returned by the list/tree/children knowledge endpoints (no
        rendered HTML).
      properties:
        _id:
          type: string
          description: Document ID.
        name:
          type: string
          description: Document title.
        emoji:
          type: string
          nullable: true
        iconUrl:
          type: string
          nullable: true
        accessType:
          type: string
          enum:
            - public
            - publicReadonly
            - private
        parentId:
          type: string
          nullable: true
          description: Parent document ID, or null for a root document.
        rank:
          type: integer
          nullable: true
          description: Sort order among siblings. May be null.
        archived:
          type: boolean
    Error:
      type: object
      properties:
        error:
          type: string
        message:
          type: string
  securitySchemes:
    ApiKeyHeader:
      type: apiKey
      in: header
      name: x-token
    DelegateToken:
      type: apiKey
      in: header
      name: Authorization
      description: 'Delegate token issued by the platform. Format: `DelegateToken <token>`'
    PartnerBearer:
      type: http
      scheme: bearer
      description: 'Partner token. Format: `Authorization: Bearer <token>`'

````