Skip to main content
POST
List audit logs

Authorizations

api_key
string
header
required

API key for authentication. See the Authentication page for your API for details on how to get your key.

Path Parameters

workspace_id
string
required

Workspace ID. See Overview for how to find it.

Body

application/json

Request body for listing audit log events.

event_types
string[] | null

Filter by one or more event types.

Example:
user_email
string | null

Filter by user email.

Example:

"jane@acme.com"

status
string | null

Filter by status. Either "success" or "failure".

Example:

"success"

start_date
string<date-time> | null

Filter events from this date (inclusive) in YYYY-MM-DDTHH:MM:SSZ format.

Example:

"2026-01-01T00:00:00Z"

end_date
string<date-time> | null

Filter events until this date (exclusive) in YYYY-MM-DDTHH:MM:SSZ format.

Example:

"2026-02-01T00:00:00Z"

app_id
string | null

App ID to narrow results to a specific app.

Example:

"6820f3a4e7b91d003c45a1f2"

limit
integer
default:50

Number of events per page.

Required range: 1 <= x <= 1000
Example:

100

cursor
string | null

Pagination cursor from a previous response.

Example:

"gAAAAABn7vJ..."

order
enum<string>
default:DESC

Sort order by timestamp.

Available options:
ASC,
DESC
Example:

"DESC"

Response

Successful Response

Response containing a page of audit log events.

events
PublicAuditLogResponse · object[]
required

List of audit log events.

pagination
PublicPaginationInfo · object
required

Pagination metadata.