Developer APIResourcesKnowledge Bases

List knowledge bases

Returns a list of knowledge bases.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

folder_idstringOptional
The ID of the folder where the knowledge base resides.
project_idstringOptional
The ID of the project where the knowledge base resides.
querystringOptional
Search query.
pageintegerOptional>=1
Page number of the knowledge bases to fetch. Minimum value is 1.
per_pageintegerOptional>=1<=50
Number of knowledge bases to return in a single page. Minimum value is 1. Maximum value is 50.
sort_termstringOptional

The field or term to sort results by. For example: name or latest_activity.

Response

List of knowledge bases retrieved successfully
idstring or null
The unique identifier of the knowledge base.
namestring or null
The name of the knowledge base.
descriptionstring or null
A description of the knowledge base.
folder_idstring or null
The ID of the folder where the knowledge base resides.
project_idstring or null
The ID of the project where the knowledge base resides.

Errors