Skip to main content
GET
JavaScript

Authorizations

Authorization
string
header
required

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.

Headers

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-08-05-1"

Query Parameters

first
integer

The number of accounts to return (default 10, max 50).

after
string

A cursor; returns accounts after this position.

last
integer

The number of accounts to return from the end of the range.

before
string

A cursor; returns accounts before this position.

order
enum<string>
default:created_at

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

Available options:
created_at,
volume
direction
enum<string>
default:desc

Sort direction.

Available options:
asc,
desc
status
enum<string>

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

Available options:
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.

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 connected accounts to return. Requires payout:account:read on the parent account.

Response

accounts listed

data
object[]
required
page_info
object
required