Endpoint
/api/v2/tenants/{tenantId}/kb/categorylist
Path Parameters
tenantIdstring
Query Parameters
statestring
Defines the current state of the category. Example: ACTIVE, INACTIVE.
clientIdstring
Defines the ID of the client and is used in Partner login.
isParentboolean
Defines the list of parent categories. If selected TRUE, only parent categories are listed.
pageNointeger
pageSizeinteger
sortNamestring
isDescendingOrderboolean
Responses
OK
descendingOrderboolean
nextPageboolean
orderBystring
pageNointeger
pageSizeinteger
previousPageNointeger
totalPagesinteger
totalResultsinteger
{
"descendingOrder": true,
"nextPage": true,
"nextPageNo": 2,
"orderBy": "id",
"pageNo": 1,
"pageSize": 10,
"previousPageNo": 0,
"results": [
{
"description": "sample description",
"id": "KBC0000000078",
"name": "API category updated",
"path": "API category updated\u003e\u003eAPI category updated",
"state": "ACTIVE"
},
{
"description": "sample description",
"id": "KBC0000000077",
"name": "API category updated",
"path": "API category updated",
"state": "ACTIVE"
},
{
"description": "Category",
"id": "KBC0000000076",
"name": "Test API category",
"path": "Test API category",
"state": "ACTIVE"
},
{
"description": "",
"id": "KBC0000000067",
"name": "test ",
"path": "test ",
"state": "ACTIVE"
},
{
"description": "hekllo",
"id": "KBC0000000066",
"name": "test ",
"path": "test ",
"state": "ACTIVE"
},
{
"description": "everything to be updated",
"id": "KBC0000000065",
"name": "test ",
"path": "test ",
"state": "ACTIVE"
},
{
"id": "KBC0000000064",
"name": "test ",
"path": "test \u003e\u003etest ",
"state": "ACTIVE"
},
{
"description": "everything to be updated",
"id": "KBC0000000063",
"name": "test ",
"path": "test ",
"state": "ACTIVE"
},
{
"description": "Hello there",
"id": "KBC0000000062",
"name": "test ",
"path": "test \u003e\u003etest ",
"state": "ACTIVE"
},
{
"description": "Hello there",
"id": "KBC0000000061",
"name": "test ",
"path": "test ",
"state": "ACTIVE"
}
],
"totalPages": 4,
"totalResults": 37
}