Skip to main content
GET
Get Accounts

Authorizations

Authorization
string
header
required

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

Query Parameters

id
string

The id of the account to filter by.

Example:

"cm9db4g2s2r7ro224ra6u1qvh"

namePrefix
string

A prefix to filter accounts by name.

Example:

"Main"

identityId
string

The id of the identity to filter accounts.

Example:

"cm9db4g2s2r7ro224ra6u1qvh"

fromDate
string<date>

Start date for filtering accounts by createdAt (YYYY-MM-DD).

Example:

"2003-01-01"

toDate
string<date>

End date for filtering accounts by createdAt (YYYY-MM-DD).

Example:

"2003-01-01"

type
enum<string>

Filter by account type. Accounts managed by a PFI are institutional. Deprecated. Will be removed by September 1st, 2026. Use provider instead.

Available options:
wallet,
institution
provider
enum<string>

Filter by the provider that manages the account. The provider that manages the account.

Available options:
Standalone,
Dfns,
Utila,
Infinia,
Finity,
TripleA,
Cobre
includeIds
string
startingAfter
string

Id used to retrieve results that come after the specified item.

limit
number

Response page limit. Min 1, Max 100, Default value is 10.

Response

200 - application/json

List of Accounts and hasMore flag.

hasMore
boolean
required
data
object[]
required