List forum topics
GET {{baseUrl}}/api/v1/communityTopics
This API lists a particular number of forum topics, based on the limit defined.
OAuth Scope
Desk.community.READ
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
categoryId | string | ID of the community category from which the topics must be listed | |
from | string | Index number, starting from which the topics must be listed | |
limit | string | Number of topics to list | |
isSticky | string | Key that defines whether the topics to list must be sticky posts or not | |
unreplied | string | Key that defines whether the topics to list must contain comments or not | |
type | string | Type of topics to list. Values allowed are: ANNOUNCEMENT, DISCUSSION, IDEA, PROBLEM, and QUESTION. | |
tagName | string | Tag by which topics must be filtered | |
label | string | Status label by which topics must be filtered. The value of this key varies according to the topic type. Values allowed are: NOSTATUS, NEEDMOREINFO, WORKINGONIT, ANSWERED, UNANSWERED, MAYBELATER, UNDERREVIEW, IMPLEMENTED, WILLNOTIMPLEMENT, NOTAPROBLEM, TEMPORARYFIX, ANALYZING, SOLVED, UNSOLVED, and MOSTVOTED. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Authorization | string |
RESPONSES
status: OK
{"data":[{"summary":"topic 2's description","creator":{"photoUrl":"https://desk.zoho.com/api/v1/agents/7000000015971/photo?orgId=123456","name":"user 1","id":"7000000015971","label":null,"type":"AGENT"},"latestCommentTime":"2018-10-16T09:42:12.716Z","subject":"Topic 2","likeCount":"1","label":"NOSTATUS","isVoted":true,"type":"QUESTION","latestCommenter":null,"isSticky":false,"commentCount":"0","portalUrl":"https://desk.zoho.com/portal/portalname/community/topictopic-2","createdTime":"2018-10-16T09:42:12.716Z","id":"4000000019017","permalink":"topic-2","categoryId":"4000000000017","status":"PUBLISHED"},{"summary":"Topic 1 description","creator":{"photoUrl":"https://desk.zoho.com/api/v1/portalUser/7000000015971/photo?orgId=123456","name":"user2","id":"7000000015972","label":{"preferences":{"shape":"RECTANGLE","bgColor":"#23F123","textColor":"#2CA123"},"name":"Admin","id":"6000000158001","logoUrl":"https://desk.zoho.com/portal/api/publicImages/6000000158231?orgId=14132"},"type":"END_USER"},"latestCommentTime":"2018-10-16T09:41:46.621Z","subject":"Topic 1","likeCount":"1","label":"NOSTATUS","isVoted":true,"type":"QUESTION","latestCommenter":{"photoUrl":"https://desk.zoho.com/api/v1/agents/7000000015971/photo?orgId=123456","name":"user 1","id":"7000000015971","label":{"preferences":{"shape":"RECTANGLE","bgColor":"#23F123","textColor":"#2CA123"},"name":"Admin","id":"6000000158001","logoUrl":"https://desk.zoho.com/portal/api/publicImages/6000000158231?orgId=14132"},"type":"AGENT"},"isSticky":false,"commentCount":"2","portalUrl":"https://desk.zoho.com/portal/portalname/community/topictopic-1","createdTime":"2018-10-16T09:41:33.202Z","id":"4000000019003","permalink":"topic-1","categoryId":"4000000000017","status":"PUBLISHED"}]}