GET /api/v2/audit_logs

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.

Filtering by multiple values

To filter by multiple values for the same field, repeat the filter parameter and append empty square brackets "[]" to the name of each repeated parameter. For example, to return audit logs where action is "create", "update", or "destroy":

/api/v2/audit_logs?filter[action][]=create&filter[action][]=update&filter[action][]=destroy

Servers

https://{subdomain}.{domain}.com

Query parameters

Name	Type	Required	Description
`page`	Object	No	Cursor-based pagination parameters (JSON:API style). Supports nested parameters: `page[size]` - Number of records per page (default varies by endpoint, typically 100) `page[after]` - Cursor token to fetch records after this position `page[before]` - Cursor token to fetch records before this position Example: `?page[size]=50&page[after]=eyJvIjoiaWQiLCJ2IjoiYVFFPSJ9`
`filter[source_type]`	String	No	Filter audit logs by the source type. For example, user or rule
`filter[actor_id]`	Integer	No	Filter audit logs by the actor id
`filter[ip_address]`	String	No	Filter audit logs by the ip address
`sort_order`	String	No	Offset pagination only. Sort audit logs. Default is `sort_order=desc`
`filter[action]`	String	No	Filter audit logs by the action
`sort`	String	No	Cursor pagination only. Sort audit logs. Default is `sort=-created_at`
`per_page`	Integer	No	Number of records to return per page. Note: Default and maximum values vary by endpoint. Check endpoint-specific documentation for limits.
`filter[source_id]`	Integer	No	Filter audit logs by the source id. Requires `filter[source_type]` to also be set
`filter[created_at]`	String	No	Filter audit logs by the time of creation. When used, you must specify `filter[created_at]` twice in your request, first with the start time and again with an end time
`sort_by`	String	No	Offset pagination only. Sort audit logs. Default is `sort_by=created_at`

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.