DocsREST APIPricing

Management API

Audit Logs

View as Markdown

List audit events

/audit/teams/{teamId}/events

Path parameters

teamId

string

required

The team id to get events for.

Query parameters

pageSize

integer

The number of events to list per page.

pageToken

string

When querying the next page, the offset token.

eventFilter.userId

string

Filter events to this user only.

eventFilter.query

string

A general search term that is used for full-text description search.

eventFilter.eventId

string

Search for a specific event by id.

eventTimeFrom

string

Filter events from and/or to certain time (optional).

eventTimeTo

string

orderBy

string

Response Body

events

array

Requested events. Ordered by event_time.

nextPageToken

string

If there are more events, the token to be used to retrieve the next page of the search results.

Did you find this page helpful?