List Audit Logs

GET {{baseUrl}}/api/v2/audit_logs?filter[actor_id]={{actor_id}}&filter[action]={{action}}&filter[created_at]>{{created_at}}

Allowed For

  • Admins on accounts that have audit log access

Pagination

  • Cursor pagination (recommended)
  • Offset pagination

See Pagination.

Returns a maximum of 100 records per page.

Request Params

KeyDatatypeRequiredDescription
filter[source_type]stringFilter audit logs by the source type. For example, user or rule
filter[source_id]stringFilter audit logs by the source id. Requires filter[source_type] to also be set.
filter[actor_id]stringFilter audit logs by the actor id
filter[ip_address]stringFilter audit logs by the ip address
filter[action]stringFilter audit logs by the action
sort_bystringOffset pagination only. Sort audit logs. Default is sort_by=created_at
sort_orderstringOffset pagination only. Sort audit logs. Default is sort_order=desc
sortstringCursor pagination only. Sort audit logs. Default is sort=-created_at
filter[created_at]>{{created_at}}null

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{"audit_logs":[{"action":"update","actor_id":1234,"actor_name":"Sameer Patel","change_description":"Role changed from Administrator to End User","created_at":"2012-03-05T11:32:44Z","id":498483,"ip_address":"209.119.38.228","source_id":3456,"source_label":"John Doe","source_type":"user","url":"https://company.zendesk.com/api/v2/audit_logs/498483.json"}]}