Docs
API ReferenceReferenceKnowledgebases

List pages

GET
/knowledgebases/{knowledgebaseId}/pages

The page index of one knowledgebase in tree order, paged. An index only: read a page with GET …/pages/{pageId}. Requires the knowledge:read scope. Browse a folder at a time with parentPageId and depth; for the big picture read the outline first.

AuthorizationBearer <token>

An organization API key, created from a Portal's Webhooks page (Provisioning API card). The secret is shown once at creation and stored only as a hash. Keys are organization-wide and carry scopes (end_users:read, end_users:write). Rate limit: 120 requests per minute per key (sliding 60-second window).

In: header

Path Parameters

knowledgebaseId*string
Formatuuid

Query Parameters

parentPageId?string

List inside one folder: its id or exact name, or null for the top level. Omit for the whole tree.

depth?integer

Levels below the parent to include; 1 = direct children only. Folders past the cut come back with collapsed: true and their counts.

Range1 <= value <= 20
limit?integer

Items per page (default 50, max 200).

Range1 <= value <= 200
cursor?string

The nextCursor from the previous page. Omit for the first page. A cursor names the last item handed out, so a walk is gapless; a stale one is refused with invalid_request.

fields?string

Comma-separated field names to keep on each item. Any of: id, title, description, templateKey, isFolder, parentPageId, path, depth, childCount, pageCount, collapsed, updatedAt, hook. An unknown name is invalid_request naming the valid ones.

updatedSince?string

Only items changed at or after this time (inclusive).

Formatdate-time

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/knowledgebases/497f6eca-6276-4993-bfeb-53cbbbba6f08/pages"
{  "knowledgebaseId": "string",  "pages": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "title": "string",      "templateKey": "string",      "parentPageId": "3b2da02d-bb1b-462e-a4ca-3235cd1dd440",      "updatedAt": "2019-08-24T14:15:22Z",      "hook": "string",      "isFolder": true,      "path": [        "string"      ],      "description": "string",      "depth": 0,      "childCount": 0,      "pageCount": 0,      "collapsed": true    }  ],  "nextCursor": "string",  "parent": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "title": "string",    "description": "string",    "isFolder": true  }}