Skip to main content
GET
List all accounts

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

clientEntityId
string<uuid>

Identifier of the client entity. Filters results to fetch only resources associated with the specified client entity. Use the clientEntityId returned when you create a client with Create a partner client (POST /v1/partner/clients). This is not the entityId of your own account returned by GET /v1/accounts.

Example:

"a3f1b2c4-d5e6-7890-abcd-ef1234567890"

type
enum<string>

Filter by account type. External account type.

  • first_party: the calling entity itself owns the account.
  • third_party: a sub-entity or end user owns the account.
Available options:
first_party,
third_party
Example:

"first_party"

purpose
enum<string>

Filter by account purpose. Intended use of the account.

  • custody: the account holds stablecoin balances for the owning entity. This is the default for new accounts.

  • payments: the account is used for Managed Payments products.

Available options:
custody,
payments
Example:

"custody"

isAttributed
boolean

Filter by whether the account is attributed to another business or end user. true returns only attributed accounts; false returns only accounts the calling entity holds directly (not on behalf of another party). Combines with the type filter. For example, type=first_party with isAttributed=true returns only the parent entity's attributed accounts.

Example:

true

status
enum<string>[]

Filter accounts by lifecycle status. Repeat the parameter to combine multiple statuses (e.g. ?status=active&status=archived). When omitted, the default behavior excludes archived accounts.

Lifecycle status of the account.

  • active: account is fully operational.
  • pending: account has been created but is not yet operational.
  • rejected: account creation was rejected and the account cannot be used.
  • archived: account has been archived and is excluded from default listings. Most mutating operations on the account (transfers, withdrawals, new address generation, etc.) are blocked while archived.
Available options:
active,
pending,
rejected,
archived
groupId
string<uuid>

Filter accounts by the custody account group they belong to.

Example:

"9c0f1c0d-6c61-4f3d-9b8a-1a3a4b3c5d6e"

from
string

Queries items created since the specified date-time (inclusive) in ISO 8601 format. ISO-8601 UTC date/time format.

Example:

"2020-04-10T02:13:30.000Z"

to
string

Queries items created before the specified date-time (inclusive) in ISO 8601 format. ISO-8601 UTC date/time format.

Example:

"2020-04-10T02:13:30.000Z"

pageBefore
string

A collection ID value used for pagination. It marks the exclusive end of a page. When provided, the collection resource will return the next n items before the id, with n being specified by pageSize.

Example:

"def9520a-5280-4089-9b02-3c9ef8fc8514"

pageAfter
string

A collection ID value used for pagination. It marks the exclusive beginning of a page. When provided, the collection resource will return the next n items after the id, with n being specified by pageSize.

Example:

"bce1e961-bdb8-4983-a9c2-0b3fbc2614cf"

pageSize
integer

Limits the number of items to be returned. The maximum is 200. A larger value is rejected with 400; it is not reduced to the maximum.

If omitted, the collection will determine the page size itself.

Required range: 1 <= x <= 200
Example:

5

Response

Successfully retrieved a list of accounts.

data
object[]