Skip to main content
GET
List events

Authorizations

Authorization
string
header
required

Your secret key: sk_test_… on the sandbox host, sk_live_… on live. A key on the wrong host gets a 401 wrong_environment. Keys are secret. Keep them on your server, never in a browser or app.

Query Parameters

limit
integer
default:20

How many to return.

Required range: 1 <= x <= 100
starting_after
string

The last id of the previous page. Returns the items after it.

type
enum<string>

One exact event type.

Available options:
payout.created,
payout.updated,
payout.awaiting_funds,
payout.pending,
payout.processing,
payout.paid,
payout.failed,
payout.returned,
payout.canceled,
payout.expired,
batch.created,
batch.processing,
batch.awaiting_funds,
batch.awaiting_payees,
batch.completed,
batch.partially_completed,
batch.failed,
batch.canceled,
payee.created,
payee.details_pending,
payee.verifying,
payee.active,
payee.inactive,
deposit.created
created[gte]
string<date-time>

Created at or after this time.

Example:

"2026-10-01T00:00:00Z"

created[lte]
string<date-time>

Created at or before this time.

Example:

"2026-10-31T23:59:59Z"

Response

Events, newest first.

data
object[]
required

The start of type says which object data.object is. It's a snapshot from when the event happened.

has_more
boolean
required
Example:

false