Get audit logs

Retrieve audit log events for the workspace with optional filtering, date range, sorting, and cursor-based pagination.

Filters within the same field are combined as OR (e.g. category=Administration&category=Security returns events in either category). Filters across different fields are combined as AND.

Deprecated parameters: timePeriod and cursor remain functional for backward compatibility but new integrations should use startTime/endTime and pageCursor instead.

Endpoint Permission: Admin, Non-Signing Admin, Auditor, Security Admin, Security Auditor.

See Audit Log Events for a complete list of available events.

Query Params
integer

Start of date range as epoch time in milliseconds. Takes precedence over timePeriod when provided. Must be no more than 1 year before the current time.

integer

End of date range as epoch time in milliseconds. Must be after startTime. Defaults to now when omitted.

string
enum
deprecated

Deprecated. Use startTime/endTime instead. Ignored when startTime is provided. Defaults to DAY when neither timePeriod nor startTime is supplied.

Allowed:
category
array of strings

Filter by event category. Repeat the parameter for multiple values (OR logic within field).

category
subject
array of strings

Filter by event subject. Repeat the parameter for multiple values.

subject
event
array of strings

Filter by event type. Repeat the parameter for multiple values.

event
user
array of strings

Filter by user name. Repeat the parameter for multiple values.

user
userId
array of strings

Filter by user ID. Repeat the parameter for multiple values.

userId
string
enum
Defaults to DESC

Sort direction. Defaults to DESC.

Allowed:
integer
1 to 500
Defaults to 200

Number of results per page. Maximum 500. Defaults to 200.

string

Cursor returned from the previous response to fetch the next page.

string
deprecated

Deprecated. Use pageCursor instead.

Responses

Language
URL
LoadingLoading…
Response
Choose an example:
application/json