List All Ticket Audits
GET {{baseUrl}}/api/v2/ticket_audits?limit=<integer>
Returns ticket audits. Archived tickets are not included in the response. Use the List Audits for a Ticket endpoint to retrieve audit records for an archived ticket. To learn more about archived tickets, see About archived tickets.
This endpoint should not be used for capturing change data. When continually chasing the tail of a cursor, some records will be skipped. For this use case, use the Incremental Ticket Event Export API.
Pagination
This API supports two cursor-based pagination methods:
- standard Zendesk cursor-based pagination
- legacy 'cursor' parameter based pagination
Zendesk recommends using the standard cursor-based pagination method. The legacy method has known problems.
Legacy cursor pagination method
By default, this endpoint uses the legacy cursor pagination method. This method differs from the standard cursor pagination used in other Zendesk endpoints.
The records are ordered sequentially by the created_at
timestamp, then by id within duplicate timestamp values. The first page will return the most recent audits.
The cursor
parameter is a non-human-readable argument you can use to move forward or backward in time.
Each JSON response will contain the following attributes to help you get more results:
after_url
requests more recent resultsbefore_url
requests older resultsafter_cursor
is the cursor to build the request yourselfbefore_cursor
is the cursor to build the request yourself.
The after_cursor
and before_cursor
attributes may contain non-URL-safe characters. Make sure to URL-encode them, or simply use the after_url
or before_url
values to paginate.
The properties are null if no more records are available.
You can request a maximum of 1,000 results. The default number of results is 1,000, but you can change it with the limit
parameter.
Allowed For
- Admins
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
limit | string | Maximum number of results returned |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"after_cursor":"MTUwMTYwNzUyMi4wfHwxMzQ3NTMxNjcxfA==","after_url":"https://subdomain.zendesk.com/api/v2/ticket_audits.json?cursor=MTUwMTYwNzUyMi4wfHwxMzQ3NTMxNjcxfA%3D%3D\u0026limit=1000","audits":[{"author_id":35436,"created_at":"2011-09-25T22:35:44Z","events":[{"attachments":[],"body":"Thanks for your help!","id":1564245,"public":true,"type":"Comment"},{"body":"Ticket #47 has been updated","id":1564246,"subject":"Your ticket has been updated","type":"Notification"},{"field_name":"status","id":1564247,"previous_value":"new","type":"Change","value":"open"},{"field_name":"custom_status_id","id":1564248,"previous_value":1,"type":"Change","value":123}],"id":2127301143,"metadata":{"custom":{"time_spent":"3m22s"},"system":{"ip_address":"184.106.40.75"}},"ticket_id":123,"via":{"channel":"web"}}],"before_cursor":"fDE1MDE1NzUxMjIuMHx8MTM0NzM0MzAxMQ==","before_url":"https://subdomain.zendesk.com/api/v2/ticket_audits.json?cursor=fDE1MDE1NzUxMjIuMHx8MTM0NzM0MzAxMQ%3D%3D\u0026limit=1000"}