page and size and return the envelope below. List Deposit Instructions and List Group Types are exceptions; see Unpaginated endpoints.
Parameters
A
page below 1 or a size outside 1 to 100 is rejected with 422 VALIDATION_ERROR.
Response format
When nothing matches,
items is empty and total is 0.
To read all results, start at page=1, keep size and filters the same, and increment page until you reach pages.
Unpaginated endpoints
Ordering
Every list is ordered by creation time, newest first. There are no sort parameters. Deleted records are left out, except on List Webhook Endpoints, which includes deleted endpoints with a non-nulldeleted_at. voided payouts and payins are left out of List Payouts and List Payins unless you pass status=voided.
Date filters
Most lists acceptstart_date and end_date as ISO 8601 datetimes on creation time: start_date is inclusive, end_date exclusive, so consecutive windows cover a set exactly once. List FX Trades filters on executed_at instead, with an inclusive end_date.
Other filters
Each endpoint page lists its own filters and values. An unsupported filter value returns
422 VALIDATION_ERROR; values are matched exactly, so active is a status and ACTIVE is not. A nested list whose parent id is unknown returns 404, except List Payout Destinations, which returns an empty page for an unknown beneficiary_id.