GET/audit-events

List audit events

Lists audit events for the authenticated team, ordered from newest to oldest. Use search, action, and source to filter events, and use page and per_page to paginate the results. Only team admins and owners can view audit events; actor email, token, metadata, changes, IP address, and user agent are returned only for tokens with read:sensitive or root permission.

5 parameters
per_pageintegeroptional
Number of audit events per page. Must be between 1 and 100. Defaults to 25 when omitted.
Default:25
pageintegeroptional
Page number, starting at 1. Defaults to 1 when omitted.
Default:1
searchstringoptional
Search text to filter audit events. Maximum 255 characters.
actionstringoptional
Filter by action; use `all` to include every action. Maximum 255 characters.
sourcestringoptional
Filter by source: `all`, `ui`, `api`, `mcp`, `webhook`, `system`, or `scheduler`.
Allowed:alluiapimcpwebhooksystemscheduler

4 status codes
200Returns a page of audit events, newest first, with pagination metadata including the current page, last page, page size, and total count.
current_pageintegeroptional
dataarray<object>optional
last_pageintegeroptional
per_pageintegeroptional
totalintegeroptional
401Returned when the request is unauthenticated.
messagestringoptional
403Returned when the authenticated user is not a team admin or owner.
422Returned when a query parameter fails validation.
errorsobjectoptional
messagestringoptional

Error handling

A 401 is returned when the request is unauthenticated; a 403 is returned when the authenticated user is not a team admin or owner; a 422 is returned when a query parameter fails validation. page and per_page must be at least 1, per_page cannot exceed 100, search and action cannot exceed 255 characters, and source must be one of all, ui, api, mcp, webhook, system, or scheduler.