Sign in

v5

latestOpenAPI 3.1.02026-08-043621,4011.8 MB
workspace

Get Workspace Audit Logs

Returns the audit log for the workspace. Requires enterprise tier and the audit_log_read permission.

get/v1/workspace/audit-logs

Query parameters

limitinteger

Maximum number of entries per page

Maximum number of entries per page

cursorstring nullable

Cursor for the next page (from previous response)

Cursor for the next page (from previous response)

time_from_unix_msinteger nullable

Only include entries at or after this time (ms since epoch)

Only include entries at or after this time (ms since epoch)

time_to_unix_msinteger nullable

Only include entries at or before this time (ms since epoch)

Only include entries at or before this time (ms since epoch)

actor_uidstring nullable

Filter by actor user ID

Filter by actor user ID

class_namestring nullable

Filter by OCSF event class name (e.g. Account Change)

Filter by OCSF event class name (e.g. Account Change)

activity_namestring nullable

Filter by audit activity name (e.g. Subscription Creation)

Filter by audit activity name (e.g. Subscription Creation)

Headers

xi-api-keystring nullable

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Response

Successful Response

has_moreboolean required
next_cursorstring nullable required