comments list
GET {{baseUrl}}/comments
Returns a list of Comment
objects.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
created_after | string | If provided, will only return objects created after this datetime. | |
created_before | string | If provided, will only return objects created before this datetime. | |
cursor | string | The pagination cursor value. | |
expand | string | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | |
include_deleted_data | boolean | Whether to include data that was deleted in the third-party service. | |
include_remote_data | boolean | Whether to include the original data Merge fetched from the third-party to produce these models. | |
modified_after | string | If provided, will only return objects modified after this datetime. | |
modified_before | string | If provided, will only return objects modified before this datetime. | |
page_size | number | Number of results to return per page. | |
remote_id | string | The API provider's ID for the given object. | |
ticket_id | string | If provided, will only return comments for this ticket. |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
X-Account-Token | string | (Required) Token identifying the end user. | |
Accept | string |
RESPONSES
status: OK
{"next":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw","previous":"cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ","results":[{"id":"0958cbc6-6040-430a-848e-aafacbadf4ae","remote_id":"19202938","author":"17a54124-287f-494d-965e-3c5b330c9a68","body":"What is the status update?","ticket":"fb8c55b6-1cb8-4b4c-9fb6-17924231619d","remote_created_at":"1990-11-10T00:00:00Z"},{"id":"0958cbc6-6040-430a-848e-aafacbadf4ae","remote_id":"19202938","author":"17a54124-287f-494d-965e-3c5b330c9a68","body":"What is the status update?","ticket":"fb8c55b6-1cb8-4b4c-9fb6-17924231619d","remote_created_at":"1990-11-10T00:00:00Z"}]}