GET /api/v2/tickets/{ticket_id}/comments
Returns the comments added to the ticket.
Each comment may include a content_url for an attachment or a recording_url for a voice comment that points to a file that may be hosted externally. For security reasons, take care not to inadvertently send Zendesk authentication credentials to third parties when attempting to access these files. See Working with url properties.
Pagination
- Cursor pagination (recommended)
- Offset pagination
See Pagination.
Returns a maximum of 100 records per page.
Sorting
By default, comments are sorted by creation date in ascending order.
When using cursor pagination, use the following parameter to change the sort order:
| Name | Type | Required | Comments |
|---|---|---|---|
sort | string | no | Possible values are "created_at" (ascending order) or "-created_at" (descending order) |
When using offset pagination, use the following parameters to change the sort order:
| Name | Type | Required | Comments |
|---|---|---|---|
sort_order | string | no | One of asc, desc. Defaults to asc |
Allowed For
- Agents
Servers
- https://{subdomain}.{domain}.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
ticket_id |
Integer | Yes |
The ID of the ticket |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
include_inline_images |
Boolean | No |
Default is false. When true, inline images are also listed as attachments in the response |
include |
String | No |
Accepts "users". Use this parameter to list email CCs by side-loading users. Example: |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.