Qodex.ai

List root categories

GET {{baseUrl}}/api/v1/kbRootCategories

This API lists a particular number of root categories, based on the limit defined.

OAuth Scope

  • Desk.articles.READ

Request Params

KeyDatatypeRequiredDescription
localestringLanguage of the category
sortBystringKey that sorts the categories, based on a specific attribute: name or order
fromstringIndex number, starting from which the categories must be fetched
limitstringNumber of categories to list
searchValuestringKeyword for searching for a particular category
statusstringActivation status of the category. Values allowed are: SHOW_IN_HELPCENTER, HIDE_IN_HELPCENTER, and DISABLED.
isTrashedstringKey that denotes whether the category is deleted or not
isReviewEnabledstringKey that specifies whether the category must be reviewed or not
visibilitystringVisibility setting of the category. Values allowed are: AGENTS, GROUP_USERS, ALL_USERS, and NONE.
departmentIdstringID of the department associated with the category
helpcenterIdstringID of the help center to which the category belongs
includestringAdditional information related to the category. Values allowed are: publicArticlesCount, allArticlesCount, and sectionsCount.

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring

RESPONSES

status: OK

{"data":[{"modifiedTime":"2020-01-05T13:18:07.000Z","visibility":"ALL_USERS","articleViewType":"LISTVIEW","allArticlesCount":"11","groups":[],"sectionsCount":"7","logoUrl":"https://desk.zoho.com/support/App/build/fonts/certificate.svg","feedbackTicketConversionPreference":{"departmentId":"5000000063895","assignee":{"photoURL":"https://desk.zoho.com/api/v1/agents/5000000000059/photo?orgId=15114553","name":"Charlie Marlie","id":"5000000000059","status":"ACTIVE","zuid":"15224545"},"status":"ENABLED"},"associatedDepartmentIds":["5000000063895"],"publicArticlesCount":"3","encryptedWorkspaceId":"04bd200bc14c4cac0c0026a0342c1f21263012407fa56109a37788e786a96ec0383c1eeb08849f9be78a6f7b8b8f31033dde60d41ad95443c6570636db1a9b20","helpcenterId":"5000000015871","isReviewEnabled":false,"isTrashed":false,"createdBy":{"photoURL":null,"name":"Zylker","id":"5000000015867","status":"ACTIVE","zuid":"343224"},"translations":[{"modifiedTime":"2019-10-10T06:18:39.000Z","createdBy":{"photoURL":null,"name":"Zylker","id":"5000000015867","status":"ACTIVE","zuid":"343224"},"name":"Zoho Desk","description":"A helpdesk software","createdTime":"2019-06-24T07:03:39.000Z","modifiedBy":{"photoURL":null,"name":"Zylker","id":"5000000015867","status":"ACTIVE","zuid":"343224"},"id":"5000000265103","permalink":"zoho-desk","locale":"en","categoryId":"5000000066427"}],"name":"Zoho Desk","createdTime":"2019-06-24T07:03:39.000Z","modifiedBy":{"photoURL":null,"name":"Zylker","id":"5000000015867","status":"ACTIVE","zuid":"343224"},"id":"5000000066427","status":"SHOW_IN_HELPCENTER","order":"1","workspaceId":"ponaz00368c36c9274809bf96849b392f8d67"}]}