v1
latestOpenAPI 3.0.02026-08-04184091.2 KBknowledgebases
List knowledgebases
Returns a list of all knowledgebases the user has access to.
get/api/v1/knowledgebases
Query parameters
limitinteger
The number of knowledgebases to get.
nextstring
Optional parameter to request the next page.
prevstring
Optional parameter to request the previous page.
sort'NAME' | '-NAME' | 'DESCRIPTION' | '-DESCRIPTION' | 'CREATED' | '-CREATED' | 'UPDATED' | '-UPDATED'
Optional resource field name to sort on, case insensitive, eg. name. Can be prefixed with - to set descending order, defaults to ascending.
countTotalboolean
Optional parameter to request total count for query
Response
Successful Operation.
Example response
{
"data": [
{
"id": "f256b3e4-03e0-4f74-ae46-a4d43882ee5d",
"name": "Organization wide knowledgebase",
"tags": [
"Red",
"Sales"
],
"ownerId": "507f191e810c19729de860ea",
"spaceId": "507f191e810c19729de860ea",
"tenantId": "507f191e810c19729de860ea",
"createdAt": "2021-10-02T14:20:50.52Z",
"createdBy": "507f191e810c19729de860ea",
"updatedAt": "2021-10-02T14:20:50.52Z",
"updatedBy": "507f191e810c19729de860ea",
"description": "This knowledgebase is used for...",
"lastIndexedAt": "2021-10-02T14:20:50.52Z",
"advancedIndexing": true,
"selectedErrorsCount": 10
}
]
}