List comments by user

GET {{baseUrl}}/api/v1/communityUsers/([0-9]+)/comments

This API lists a particular number of comments by a user, 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
startTimestringStarting time of the time range in which the comments should have been created. The value must be expressed according to the GMT time zone.
endTimestringEnding time of the time range in which the comments should have been created. The value must be expressed according to the GMT time zone.

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring

RESPONSES

status: OK

{"data":[{"summary":"Comment 1","topicPeramlink":"zoho-desk-api","creator":{"photoUrl":"https://desk.zoho.com/api/v1/agents/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":"AGENT"},"topicId":"4000000019013","subject":"Zoho Desk API","createdTime":"2018-10-16T09:41:40.077Z","parentCommentId":"4000000019012","id":"4000000019013","categoryId":"4000000000017","status":"PUBLISHED","topicType":"PROBLEM"},{"summary":"Comment 2","topicPeramlink":"zoho-desk-api-features","creator":{"photoUrl":"https://desk.zoho.com/api/v1/agents/7000000015971/photo?orgId=123456","name":"user2","id":"7000000015972","type":"AGENT"},"topicId":"4000000019013","subject":"Zoho Desk API Features","createdTime":"2018-10-16T10:21:00.386Z","parentCommentId":null,"id":"4000000019029","categoryId":"4000000000017","status":"PUBLISHED","topicType":"PROBLEM"}]}