Knowledge base pages
List published documents for a knowledge base
Knowledge base pages are the published versions of pages that are part of a knowledge base. A knowledge base must be enabled in order to access its pages.
get/knowledge_bases/{knowledge_base_id}/pages
Request
- Base URLhttps://company.aha.io/api/v1
- Auth
- OAuth 2Authorization codehttps://{account-domain}.aha.io/oauth/authorizeToken URLhttps://{account-domain}.aha.io/oauth/token
- or HTTP bearer
- or API key in cookie session
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
knowledge_base_idstring required
KnowledgeBaseId identifier
Query parameters
pagestring
per_pagestring
qstring
Response
Successful operation
Example response
{
"page": {
"id": "934552841",
"name": "Knowledge only parent note",
"title": "KB-N-1 Knowledge only parent note",
"document_title": "Knowledge only parent note | Aha!",
"updated_at": "2019-01-01T00:00:00.000Z",
"emoji_value": null,
"document_type": 10,
"document_type_name": "note",
"type_name": "note",
"position": 100000,
"created_at": "2019-01-01T00:00:00.000Z",
"location": null,
"url": "https://knowledge-company.aha.site/kb/knowledge-base-standalone/knowledge-only-parent-note~934552841",
"knowledge_base_id": "701841993",
"publishing_status": "Published",
"parent_id": null,
"description": {
"id": "25224705",
"body": "Body of first knowledge only note",
"notable_id": "934552841",
"notable_type": "Page",
"editor_version": 1,
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z",
"attachments": []
},
"collections": [],
"custom_fields": []
}
}Changes
No recorded changes to this operation across all 2 revisions of this API.