Skip to main content
GET
TypeScript

Autorisaties

Authorization
string
header
vereist

An Account API key, an account access token, an account-scoped user token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Scopes

company:basic:read
company:balance:read

Headers

Api-Version-Date
string

Pins the request to a dated API version.

Voorbeeld:

"2026-11-17"

Queryparameters

first
integer
standaard:10

Number of results to return from the start of the range.

Vereist bereik: x <= 50
after
string

Return results after this cursor. Use page_info.end_cursor from the previous response to fetch the next page.

last
integer

Number of results to return from the end of the range.

Vereist bereik: x <= 50
before
string

Return results before this cursor. Use page_info.start_cursor from the previous response to fetch the previous page.

order
enum<string>
standaard:created_at

The field to sort accounts by. volume requires stats:read on the parent account.

Beschikbare opties:
created_at,
volume
direction
enum<string>
standaard:desc

Sort direction.

Beschikbare opties:
asc,
desc
status
enum<string>

Return only accounts with this status: active (includes accounts that have not entered payments review) or suspended.

Beschikbare opties:
active,
suspended
query
string

Free-text filter on account title or ID. % and _ match literally.

created_after
string<date-time>

Return only accounts created after this ISO 8601 timestamp.

created_before
string<date-time>

Return only accounts created before this ISO 8601 timestamp.

external_id
string

Return only the subaccount with this external_id, matched exactly and case-sensitively. End it with % to return every subaccount whose external_id starts with the text before it, such as shopline:%. % is accepted only at the end, because anywhere else it would scan all your subaccounts. _ always matches literally.

volume_min
number

Return only accounts whose lifetime USD volume is at least this value. Requires stats:read on the parent account.

volume_max
number

Return only accounts whose lifetime USD volume is at most this value. Requires stats:read on the parent account.

parent_account_id
string

For platforms: the parent account ID whose direct subaccounts to return. Requires payout:account:read on the parent account.

owner_id
string

Return only accounts owned by this user (user_...), the account's owner. Cannot be combined with parent_account_id.

Respons

accounts listed

data
object[]
vereist
page_info
object
vereist