List Audit Events
Beta/v1/core/audit-eventsThis endpoint is idempotent. Learn more
Returns a paginated list of audit events for the current account.
cursoroptional stringQuery parameter: cursor for List Audit Events
limitoptional integerQuery parameter: limit for List Audit Events
qoptional stringQuery parameter: q for List Audit Events
start_dateoptional string (date-time)Start of date range for occurred_at.
end_dateoptional string (date-time)End of date range for occurred_at.
resource_typeoptional stringenumValues:accountactorentityResource type of the audited entity.
resource_idoptional stringAudited resource ID.
actor_idoptional stringActor ID.
actionoptional stringenumValues:createupdatedeleteAudit action.
account_idoptional stringActor home account ID.
include[]optional arrayenumValues:actorchangesmetadataSub-objects to expand in the response. When omitted, sub-objects are returned as null.
objectstringenumValues:listObject type for AuditEvent list
page_infoobjectPagination metadata for AuditEvent list
next_cursorstringnullableCursor to fetch the next page, null if no more pages.
prev_cursorstringnullableCursor to fetch the previous page, null if on the first page.
has_next_pagebooleanWhether more results exist after this page.
has_prev_pagebooleanWhether results exist before this page.
dataarray of objectArray of AuditEvent resources in this page
idstringAudit event ID.
objectstringenumValues:audit_eventResource type identifier.
actionstringenumValues:createupdatedeleteMutation type.
resource_typestringenumValues:accountactorentityResource type of the audited entity.
resource_idstringAudited resource ID.
actorobjectExpandablenullableActor who performed the mutation.
idstringActor ID.
objectstringenumValues:actorResource type identifier.
typestringenumValues:userapi_keyagentActor type.
namestringnullableDisplay name.
handlestringnullableHuman-readable handle (email for users, redacted value for API keys, slug for agents).
roleobjectnullableAssigned role.
null in this endpoint.changesobjectExpandablenullableField-level changes recorded for this event.
objectstringenumValues:listObject type for AuditFieldChange list
page_infoobjectPagination metadata for AuditFieldChange list
next_cursorstringnullableCursor to fetch the next page, null if no more pages.
prev_cursorstringnullableCursor to fetch the previous page, null if on the first page.
has_next_pagebooleanWhether more results exist after this page.
has_prev_pagebooleanWhether results exist before this page.
dataarray of objectArray of AuditFieldChange resources in this page
fieldstringName of the changed field.
old_valueobjectPrevious value as a JSON fragment. Null for creation events.
new_valueobjectNew value as a JSON fragment. Null for deletion events.
metadataobjectExpandableArbitrary JSON metadata for the mutation (e.g. reason, source, tags).
request_idstringnullableOriginating HTTP request ID.
idempotency_keystringnullableIdempotency key of the originating request.
source_ipstringnullableOriginating client IP address.
occurred_atstring (date-time)When the audited mutation occurred.
created_atstring (date-time)When the audit event record was created.
Responses
Successful response for List Audit Events