Qodex.ai

List all account comments

GET {{baseUrl}}/v1/accounts/:account_id/comments

This API lists a particular number of comments recorded on an account, based on the limit specified.

OAuth Scope

  • Desk.contacts.READ

Request Params

KeyDatatypeRequiredDescription
fromstringIndex number starting from which the comments must be fetched.
limitstringNo. of comments to fetch
sortBystringsortby can be commentedTime. default order : commentedTime in descending order , prefix - denotes desc
includestringSecondary information related to the comments. Value allowed is mentions, which returns the details of users mentioned in the comments.

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring

RESPONSES

status: OK

{"data":[{"modifiedTime":null,"commentedTime":"2017-01-24T19:45:55.000Z","id":"4000000530049","contentType":"plainText","commenterId":"4000000008692","content":"Sample zsu[@user:55616589]zsu and zsu[@team:31138000001254025_new team]zsu testing","mention":[{"firstName":"","lastName":"pandees","photoURL":null,"offSet":"7","length":"28","id":"31138000000573164","type":"AGENT","email":"jade15tywin@zylker.com","zuid":"55616589"},{"offSet":"39","length":"46","name":"new team","id":"31138000001254025","type":"TEAM"},{"offSet":"59","departmentId":"3113800000634345","length":"26","id":"3113800000143134","type":"TICKET"}],"commenter":{"firstName":"Jade","lastName":"Tywin","photoURL":"https://desk.zoho.com/api/v1/agents/4000000008692/photo?orgId=292828","name":"Jade Tywin","roleName":"LightAgent","type":"AGENT","email":"jade12tywin@zylker.com"}},{"modifiedTime":"2017-01-24T19:46:24.000Z","commentedTime":"2017-01-24T19:45:21.000Z","id":"4000000530047","contentType":"html","commenterId":"4000000008692","content":"Sample zsu[@user:55616589]zsu and zsu[@team:31138000001254025_new team]zsu testing","mention":[{"firstName":"","lastName":"pandees","photoURL":null,"offSet":"7","length":"28","id":"31138000000573164","type":"AGENT","email":"jade15tywin@zylker.com","zuid":"55616589"},{"offSet":"39","length":"46","name":"new team","id":"31138000001254025","type":"TEAM"},{"offSet":"59","departmentId":"3113800000634345","entityNumber":"1342","length":"26","name":"","id":"3113800000143134","type":"TICKET"}],"commenter":{"firstName":"Jade","lastName":"Tywin","photoURL":"https://desk.zoho.com/api/v1/agents/4000000008692/photo?orgId=292828","name":"Jade Tywin","roleName":"LightAgent","type":"AGENT","email":"jade12tywin@zylker.com"}}]}