Skip to navigation

List audit events

What changed, who or which agent changed it, and through which surface, for configuration and money-affecting actions: outcome definition, plan and webhook endpoint changes, provider and routing changes, reversals, dispute decisions, credit grants and voids, config proposals, holding a catalog price change (catalog.price_change_held) and a customer’s auto top-up rule being created, changed or turned off (auto_top_up.created, auto_top_up.updated, auto_top_up.turned_off), each with its actor. Events are kept for at least 13 months. Needs audit:read.

Authentication

AuthorizationBearer

A secret key (rl_sk_test_..., rl_sk_live_...) or a restricted key with limited scopes (rl_rk_test_..., rl_rk_live_...). A restricted key can carry agent: true and an expires_at, and is what a coding agent should hold. Keys end in a checksum so secret scanners can recognize them. People create, roll and revoke keys in the dashboard; GET /v1/api_keys lists them, masked.

Query parameters

actor_typeenumOptional
Only events by this kind of actor.
Allowed values:
actorstringOptional
Only events by this actor ID, such as a user, key or agent.
resourcestringOptional
Only events on this object ID or key.
sourceenumOptional
Only events made through this surface.
Allowed values:
fromdatetimeOptional
Only events at or after this time.
todatetimeOptional
Only events before this time.
limitintegerOptional1-100Defaults to 20
Maximum number of objects to return, from 1 to 100.
cursorstringOptional

The next_cursor from the previous page.

Response

A page of audit events.
object"list"
datalist of objects
has_moreboolean
next_cursorstringOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error
500
Internal Server Error