List all contact comments

GET {{baseUrl}}/v1/contacts/:contact_id/comments

This API lists a particular number of comments recorded on a contact, 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:35:23.000Z","id":"4000000530045","contentType":"plainText","content":"second contact comment","commenterId":"4000000008692","mention":[],"commenter":{"firstName":"Jade","lastName":"Tywin","photoURL":"https://desk.zoho.com/api/v1/portalUser/4000000008692/photo?orgId=292828","name":"Jade Tywin","roleName":"PortalUser","type":"END_USER","email":"jade12tywin@zylker.com"}},{"modifiedTime":null,"commentedTime":"2017-01-24T19:34:56.000Z","id":"4000000530043","contentType":"html","content":"First contact comment","commenterId":"4000000008692","mention":[],"commenter":{"firstName":"Jade","lastName":"Tywin","photoURL":"https://desk.zoho.com/api/v1/agents/4000000008692/photo?orgId=292828","name":"Jade Tywin","roleName":"CEO","type":"AGENT","email":"jade12tywin@zylker.com"}}]}