Audit Logs

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.

get/management/audit_logs

Request

Query parameters

startTimeinteger

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.

endTimeinteger

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

timePeriod'DAY' | 'WEEK'

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

categorystring[]

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

subjectstring[]

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

eventstring[]

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

userstring[]

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

userIdstring[]

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

order'ASC' | 'DESC'

Sort direction. Defaults to DESC.

pageSizeinteger

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

pageCursorstring

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

cursorstring

Deprecated. Use pageCursor instead.

Response

Audit log events matching the requested filters and date range

nextstring nullable

Cursor to pass as pageCursor in the next request. Null when no further pages exist.

cursorstring nullable

Deprecated. Use next instead.

Example response

{
  "data": [
    {
      "category": "Administration"
    }
  ],
  "next": "eyJpZCI6IjEyMzQ1NiJ9"
}

Changes

No recorded changes to this operation across all 1 revision of this API.