Skip to main content
GET
List success events

Authorizations

Authorization
string
header
required

A workspace API token. Create one in Settings → API. Send it as Authorization: Bearer sk_live_....

Query Parameters

event_code
string | null

Only events of this type code.

entry_kind
enum<string> | null

record or reversal. BR-25: a reversal is always a NEW row in billing_success_events, never a mutation of the RECORD row it reverses.

Available options:
record,
reversal
contact_id
string | null

Only events for this contact. Unique identifier for a contact.

Pattern: ^con_[0-9a-f]{32}$
Example:

"con_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4"

occurred_from
string<date-time> | null

Only events that occurred at or after this instant.

occurred_to
string<date-time> | null

Only events that occurred before this instant.

limit
integer
default:50

Items per page (max 200).

Required range: 1 <= x <= 200
cursor
string | null

Opaque cursor from a previous response's links.next.

Response

Successful Response

A page of success events.

data
SuccessEvent · object[]
required
meta
PageMeta · object
required