API ReferenceReferenceKnowledgebases
Get the outline
The knowledgebase's folders, each with its one-line description and page counts, nested, plus the top-level pages filed in no folder. Generated from the live pages, never stale. Start here, then list a folder's pages with parentPageId. Free. Requires the knowledge:read scope.
Authorization
apiKey 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
Format
uuidResponse 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/outline"{ "knowledgebase": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "description": "string" }, "folders": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "title": "string", "description": "string", "pageCount": 0, "childCount": 0, "folders": [ {} ] } ], "unfiledPages": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "title": "string", "description": "string" } ], "totals": { "pages": 0, "folders": 0 }}