Get a category tree
GET {{baseUrl}}/api/v1/kbRootCategories/:rootCategoryId/categoryTree
This API fetches the full tree of a root category in your helpdesk
OAuth Scope
Desk.articles.READ
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
locale | string | Locale of the translated name | |
sortBy | string | Sort order of the categories. Allowed values : name, order | |
includeTrash | string | Presence flag of the category | |
include | string | Include params are publicArticlesCount, allArticlesCount |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Authorization | string |
RESPONSES
status: OK
{"visibility":"ALL_USERS","allArticlesCount":"0","description":"test","locale":"en","logoUrl":"https://desk.zoho.com/support/App/build/fonts/certificate.svg","publicArticlesCount":"0","isTrashed":false,"children":[{"visibility":"ALL_USERS","allArticlesCount":"0","description":"Desk","locale":"en","logoUrl":"https://desk.zoho.com/support/App/build/fonts/certificate.svg","rootCategoryId":"5000000066427","publicArticlesCount":"0","isTrashed":false,"children":[{"visibility":"ALL_USERS","allArticlesCount":"0","description":"Section 2","locale":"en","logoUrl":"https://desk.zoho.com/support/App/build/fonts/certificate.svg","rootCategoryId":"5000000066427","publicArticlesCount":"0","isTrashed":false,"children":[],"translations":[{"name":"section 2 en","description":null,"id":"5000000341003","permalink":"section-2-en","locale":"en"}],"name":"Section 2","parentCategoryId":"5000000340014","id":"5000000341001","status":"SHOW_IN_HELPCENTER","order":"1"}],"translations":[{"name":"For Agents","description":null,"id":"5000000340016","permalink":"for-agents","locale":"en"}],"name":"Desk","parentCategoryId":"5000000066427","id":"5000000340014","status":"SHOW_IN_HELPCENTER","order":"5"}],"translations":[{"name":"Desk","description":"Helpdesk-software","id":"5000000265103","permalink":"desk","locale":"en"}],"name":"test","id":"5000000066427","status":"SHOW_IN_HELPCENTER","order":"1"}