Retrieve audit logs with support for search, sorting, pagination, and optional date filtering.
Search
q=column_name:search_string1,search_string2 to filter by field values.q parameters are allowed and are combined using search_operator.Sorting
sort=column_name,-column_name.- to sort in descending order.Date filtering
from_date filters logs with occurred_at >= from_date.to_date filters logs with occurred_at <= to_date.The response returns a paginated list of audit logs and the total count of matching records.
Authenticate requests using a bearer token.
Supported token types:
Header format
Authorization: Bearer <your_token>Name of the organization to scope the request to. This header is required in multi-tenant deployments.
Organization name used to resolve the tenant context.
API version identifier (for example, v1 or v2). Defaults to v1
when not provided.
API version to target for this request.
Search filters in the format column_name:search_string1,search_string2.
Logical operator used to combine multiple q query parameters.
or — return logs that match any filterand — return logs that match all filtersOperator used to combine multiple q filters (or or and).
Sort order for the results in the format column_name,-column_name.
Prefix a column with - to sort in descending order.
Sort columns in the format column_name,-column_name where - denotes
descending order.
Maximum number of records to return in a single page of results.
Maximum number of results to return for this request.
1 <= x <= 1000Number of records to skip before starting to return results.
Number of results to skip from the start of the result set.
x >= 0Filters results to logs with occurred_at >= from_date (ISO 8601).
Lower bound (inclusive) for occurred_at when filtering results.
"<timestamp>"
Filters results to logs with occurred_at <= to_date (ISO 8601).
Upper bound (inclusive) for occurred_at when filtering results.
"<timestamp>"
Request succeeded and a paginated list of audit logs is returned.