latestOpenAPI 3.0.12026-08-192092911.2 MB
916e669fc527
Notes
Get a list of note comments
Retrieves a list of comments for a specific note (required scope notes:read)
get/v1/notes/{noteId}/comments
Path parameters
noteIdinteger required
The unique identifier of the note
Headers
Customer-Idinteger required
The customer identifier
Response
OK
Example response
{
"items": [
{
"id": 5514123,
"entityType": "contact",
"entityId": 5514123,
"contactId": 47644689,
"typeId": 5514123,
"createdAt": "2022-11-29T16:50:16.0000000+00:00",
"subject": "Call Mr Brown",
"parentId": 5514123,
"dueAt": "2022-11-29T16:50:16.0000000+00:00",
"progressedAt": "2022-11-29T16:50:16.0000000+00:00",
"reference": "5514123",
"status": "open",
"description": "Message left by Mr Brown regarding the recent installation of his CCTC cameras. He can't get one of them working and needs some technical support.",
"completionText": "Called the customer, he is now happy with the work",
"progressPercentage": 50,
"createdByUserName": "Mr. Jones",
"ownedByUserId": 1245,
"ownedByUserName": "Mr. Smith",
"customFields": [
{
"definitionId": 5514123,
"value": "Purple",
"definition": {
"caption": "Favourite colour",
"type": "boolean",
"listOptions": [
"Red",
"Blue",
"Green",
"Purple"
],
"isRequired": true,
"isEditable": true,
"default": "10"
},
"systemListValueMetadata": {
"label": "John Doe",
"entityType": "resource"
}
}
]
}
],
"pageNumber": 2,
"pageSize": 100,
"pageItemCount": 55
}