Skip to main content
GET
JavaScript

Authorizations

Authorization
string
header
required

A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like Bearer ***************************

Headers

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-07-20"

Query Parameters

account_id
string

The owning account ID (a biz_ identifier). Provide this or user_id.

user_id
string

The owning user ID (a user_ identifier). Provide this or account_id.

currency
string

Optional currency code filter, for example usd.

first
integer
default:20

Number of payouts to return from the start of the window.

Required range: x <= 100
after
string

Cursor to fetch the page after (from page_info.end_cursor).

last
integer

Number of payouts to return from the end of the window.

Required range: x <= 100
before
string

Cursor to fetch the page before (from page_info.start_cursor).

Response

payout method nulled without the destination-read scope

data
object[]
required
page_info
object
required