List Events
Retrieve a paginated list of events for a given organisation, with optional sorting and filtering parameters
Authorizations
Query Parameters
Filter events related to a specific document/payment/invoice ID.
Filter by EventAction label.
Unknown, Created, Updated, Queued, Processed, Disabled, Enabled, Canceled, Refunded, Overdue, Delayed, Settled, LowBalanceDetected, VirtualAccountAlert Filter by latest delivery outcome.
succeeded, failed Filter by EventType label.
Unknown, Org, MerchantContract, Customer, Payment, Plan, Subscription, Invoice, Transaction, OfframpTransaction, CryptoTransaction, Account Page size. Defaults to 100. Minimum 1, maximum 100.
1 <= x <= 100Page number (1-based). Defaults to 1.
x >= 1Inclusive lower bound on created_at (RFC3339). When set, results are sorted by created_at.
Sort direction for the primary list key (created_at when since/until are set, otherwise id). Defaults to desc.
asc, desc Sort order field. Use delivered_at to order by delivery time; default is legacy (id/timestamp).
delivered_at Inclusive upper bound on created_at (RFC3339). When set, results are sorted by created_at.