Get topic by permalink

GET {{baseUrl}}/api/v1/communityTopicByPermalink?permalink=<String>

This API fetches a forum topic, based on the permalink in the API request.

OAuth Scope

  • Desk.community.READ

Request Params

KeyDatatypeRequiredDescription
permalinkstringpermalink of the topic

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring

RESPONSES

status: OK

{&quot;creator&quot;:{&quot;photoUrl&quot;:&quot;https://desk.zoho.com/api/v1/agents/7000000015971/photo?orgId=123456&quot;,&quot;name&quot;:&quot;user 1&quot;,&quot;id&quot;:&quot;7000000015971&quot;,&quot;label&quot;:{&quot;preferences&quot;:{&quot;shape&quot;:&quot;RECTANGLE&quot;,&quot;bgColor&quot;:&quot;#23F123&quot;,&quot;textColor&quot;:&quot;#2CA123&quot;},&quot;name&quot;:&quot;Admin&quot;,&quot;id&quot;:&quot;6000000158001&quot;,&quot;logoUrl&quot;:&quot;https://desk.zoho.com/portal/api/publicImages/6000000158231?orgId=14132&quot;},&quot;type&quot;:&quot;END_USER&quot;},&quot;attachments&quot;:[{&quot;size&quot;:&quot;1166&quot;,&quot;name&quot;:&quot;download.png&quot;,&quot;id&quot;:&quot;4000000019027&quot;,&quot;href&quot;:&quot;https://desk.zoho.com/api/v1/communityTopics/4000000019003/attachments/4000000019027/content?orgId=123456&quot;}],&quot;isFollowing&quot;:false,&quot;subject&quot;:&quot;Topic 1&quot;,&quot;isModerated&quot;:false,&quot;likeCount&quot;:&quot;1&quot;,&quot;label&quot;:&quot;NOSTATUS&quot;,&quot;isVoted&quot;:true,&quot;type&quot;:&quot;QUESTION&quot;,&quot;isSticky&quot;:false,&quot;content&quot;:&quot;\u003cdiv style=\&quot;font-size: 13px; font-family: Arial, Helvetica, Verdana, sans-serif\&quot;\u003e\u003cdiv\u003eTopic 1 dscription\u003cbr /\u003e\u003c/div\u003e\u003c/div\u003e&quot;,&quot;bestCommentId&quot;:null,&quot;commentCount&quot;:&quot;2&quot;,&quot;portalUrl&quot;:&quot;https://desk.zoho.com/portal/portalname/community/topictopic-1&quot;,&quot;isLocked&quot;:false,&quot;createdTime&quot;:&quot;2018-10-16T09:41:33.202Z&quot;,&quot;followersCount&quot;:&quot;0&quot;,&quot;tag&quot;:[{&quot;name&quot;:&quot;tag1&quot;,&quot;permalink&quot;:&quot;tag1&quot;},{&quot;name&quot;:&quot;tag2&quot;,&quot;permalink&quot;:&quot;tag2&quot;}],&quot;id&quot;:&quot;4000000019003&quot;,&quot;permalink&quot;:&quot;topic-1&quot;,&quot;categoryId&quot;:&quot;4000000000017&quot;,&quot;status&quot;:&quot;PUBLISHED&quot;,&quot;isTicketCreated&quot;:false}