Get category or forum by permalink
GET {{baseUrl}}/api/v1/communityCategoryByPermalink?permalink=<String>
This API fetches the details of a community category or forum, based on the permalink in the API request.
OAuth Scope
Desk.community.READ
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
permalink | string | Permalink of the category or forum to fetch | |
include | string | Additional information related to the category or forum. Values allowed are: postCount, followersCount, and commentCount. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Authorization | string |
RESPONSES
status: OK
{"isFollowing":"true","visibility":"ALL_USERS","departmentId":"20628000000020011","description":"description","canAutoConvertTicket":true,"childs":[{"isFollowing":false,"visibility":"ALL_USERS","departmentId":null,"description":"forum 1","canAutoConvertTicket":null,"commentCount":"491","associatedDepartmentIds":["20628000000020011"],"photoUrl":null,"view":{"groupIds":[],"permission":"ALL_USERS"},"post":{"groupIds":[],"permission":"ALL_USERS"},"permissions":["POST","RESPOND"],"moderation":null,"name":"forum","deparmentIdForTicketCreation":"20628000000020011","postCount":"246","parentCategoryId":"4000000003037","id":"4000000012009","position":"1","followersCount":"38","permalink":"forum-43","respond":{"groupIds":[],"permission":"ALL_USERS"},"child":[],"moderators":[],"status":"ENABLED"}],"commentCount":"491","associatedDepartmentIds":["20628000000020011"],"photoUrl":null,"view":{"groupIds":[],"permission":"ALL_USERS"},"post":{"groupIds":[],"permission":"ALL_USERS"},"permissions":["POST","RESPOND"],"moderation":"NONE","name":"new dep","deparmentIdForTicketCreation":"20628000000020011","postCount":"246","parentCategoryId":"null","id":"20628000000020011","position":"1","followersCount":"38","permalink":"new-dep","respond":{"groupIds":[],"permission":"ALL_USERS"},"status":"ENABLED","moderators":[{"photoUrl":"https://desk.zoho.com/api/v1/agents/7000000015971/photo?orgId=123456","name":"user 2","id":"7000000015971","type":"AGENT"},{"photoUrl":"https://desk.zoho.com/api/v1/agents/7000000015972/photo?orgId=123456","name":"user 3","id":"7000000015972","type":"AGENT"}]}