List comments pending moderation

GET {{baseUrl}}/api/v1/communityModeration/comments?status=<String>

This API lists a particular number of comments that are pending moderation, based on the limit defined.

OAuth Scope

  • Desk.community.READ

Request Params

KeyDatatypeRequiredDescription
categoryIdstringID of the community category from which the comments must be fetched
fromstringIndex number, starting from which the comments must be listed
limitstringNumber of comments to list
statusstringModeration status of the comments. Values allowed are: AWAITINGAPPROVAL, SPAM, and TRASHED.

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring

RESPONSES

status: OK

{&quot;data&quot;:[{&quot;summary&quot;:&quot;Comment 1&quot;,&quot;topicPeramlink&quot;:&quot;zoho-desk-api&quot;,&quot;creator&quot;:{&quot;photoUrl&quot;:&quot;https://desk.zoho.com/api/v1/agents/7000000015971/photo?orgId=123456&quot;,&quot;name&quot;:&quot;user1&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;topicId&quot;:&quot;4000000019013&quot;,&quot;trashedBy&quot;:null,&quot;subject&quot;:&quot;Zoho Desk API&quot;,&quot;createdTime&quot;:&quot;2018-10-16T09:41:40.077Z&quot;,&quot;id&quot;:&quot;4000000019013&quot;,&quot;categoryId&quot;:&quot;4000000019012&quot;,&quot;status&quot;:&quot;AWAITINGAPPROVAL&quot;},{&quot;summary&quot;:&quot;Comment 2&quot;,&quot;topicPeramlink&quot;:&quot;zoho-desk-api-features&quot;,&quot;modifiedTime&quot;:&quot;2018-10-16T10:28:59.495Z&quot;,&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;topicId&quot;:&quot;4000000019013&quot;,&quot;trashedBy&quot;:null,&quot;subject&quot;:&quot;Zoho Desk API Features&quot;,&quot;createdTime&quot;:&quot;2018-10-16T10:21:00.386Z&quot;,&quot;id&quot;:&quot;4000000019029&quot;,&quot;categoryId&quot;:&quot;4000000019012&quot;,&quot;status&quot;:&quot;AWAITINGAPPROVAL&quot;}]}