Skip to main content
GET
Read the PULL feed

Authorizations

API-KEY
string
header
required

Your partner API key. Requires the webhooks permission, or events for the PULL feed.

Headers

Api-Version
string
default:2026-09.1
required

The API version this request targets. Required on every /api/v0/* call. Format YYYY-MM.<release>; 2026-09.1 is the latest. The version that served the request is echoed back on the response. Missing, malformed or unsupported values are rejected with 400.

Pattern: ^\d{4}-\d{2}\.\d+$

Query Parameters

types
string

Narrow the results to these event types — ?types=payout.completed&types=payout.failed. This can only narrow your subscription's eventFilter, never widen it: a type your PULL subscription does not carry stays invisible no matter what you ask for here.

startDate
string

Inclusive lower bound on eventCreatedAt. An ISO-8601 instant (2026-05-21T10:00:00Z) or a bare date (2026-05-21, read as 00:00:00Z). Omit for an open start.

endDate
string

Inclusive upper bound on eventCreatedAt. Same two formats; a bare date is read as 23:59:59.999999Z. Omit for an open end.

after
string

Pagination cursor.

limit
integer
default:25

Page size, maximum 100.

Required range: x <= 100

Response

A page of events.

code
integer

The HTTP status, repeated in the body.

message
string

A human-readable summary.

status
enum<string>

SUCCESS on a 2xx.

Available options:
SUCCESS,
ERROR
data
object
errors
object[]

Empty on success.