List all contract comment
GET {{baseUrl}}/v1/contracts/:contract_id/comments
This API lists a particular number of comments recorded on a contract, based on the limit specified.
OAuth Scope
Desk.settings.READ
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
from | string | Index number starting from which the comments must be fetched | |
limit | string | No. of comments to fetch | |
sortBy | string | sortby can be commentedTime . default order : commentedTime in descending order , prefix - denotes desc | |
include | string | Secondary information related to the comments. Value allowed is mentions , which returns the details of users mentioned in the comments. |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Authorization | string |
RESPONSES
status: OK
{"data":[{"modifiedTime":"2017-01-24T19:50:40.000Z","attachments":[{"size":"12734","name":"Attachment_edited.png","id":"4000000008994","href":"https://desk.zoho.com/api/v1/contracts/4000000528005/comments/4000000529001/attachments/4000000008994/content"}],"commentedTime":"2017-01-24T19:50:08.000Z","id":"4000000530053","contentType":"html","commenterId":"4000000008692","content":"second contract comment edit","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:49:34.000Z","id":"4000000530051","contentType":"plainText","commenterId":"4000000008692","content":"First contract comment","mention":[]}]}