Skip to main content
GET
List audit events

Authorizations

Authorization
string
header
required

Portal API Key (Custodian API Key). Pass as a Bearer token in the Authorization header.

Query Parameters

take
integer
default:50

The number of audit events to retrieve. Min 1, max 100. Default 50.

Required range: 1 <= x <= 100
cursor
string

The metadata.cursor value from the previous response. Pass it back unchanged to fetch the next page.

userIds
string

Comma-delimited list of Portal Dashboard user IDs to filter by.

eventTypes
string

Comma-delimited list of audit event types to filter by, for example member:invite,client:create. Use GET /custodians/me/audit-events/types for the full list of valid values.

since
number

Returns only audit events created at or after this Unix timestamp (in seconds). Must be less than until when both are provided.

until
number

Returns only audit events created at or before this Unix timestamp (in seconds).

Response

Audit events retrieved successfully

results
object[]
required
metadata
object
required