List categories
GET {{baseUrl}}/api/v1/communityCategory
This API lists a particular number of community categories.
OAuth Scope
Desk.community.READ
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
include | string | Additional information related to the categories. Values allowed are: postCount, followersCount, and commentCount. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Authorization | string |
RESPONSES
status: OK
{"categories":[{"isFollowing":true,"visibility":"LOGGED_IN_USERS","departmentId":"2000000012968","description":"category","canAutoConvertTicket":false,"photoUrl":null,"permissions":["POST","RESPOND"],"moderation":"NONE","name":"category","parentCategoryId":null,"id":"4000000000017","position":"1","permalink":"category","child":[{"isFollowing":false,"visibility":null,"departmentId":null,"description":"Forum 1","canAutoConvertTicket":null,"photoUrl":null,"permissions":["POST","RESPOND"],"moderation":null,"name":"forum 1","parentCategoryId":"4000000000017","id":"4000000000033","position":"1","permalink":"forum-1","child":[],"moderators":[],"status":"ENABLED"}],"moderators":[{"photoUrl":null,"name":"User 1","id":"2000000016079","type":"AGENT"}],"status":"ENABLED"},{"isFollowing":false,"visibility":"LOGGED_IN_USERS","departmentId":null,"description":"","canAutoConvertTicket":true,"photoUrl":null,"permissions":["POST","RESPOND"],"moderation":"FIRST_POST","name":"Dep 2","parentCategoryId":null,"id":"4000000002005","position":"2","permalink":"dep-2","child":[],"moderators":[],"status":"ENABLED"}]}