Skip to main content
GET
/
v1
/
accounts
List all accounts
curl --request GET \
  --url https://api-sandbox.circle.com/v1/accounts \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "accountId": "1000662322",
      "entityId": "a49f9b1d-75e0-44a9-b8d2-4293b3f11ebd",
      "type": "first_party",
      "purpose": "custody",
      "status": "active",
      "description": "End User Wallet",
      "balances": [
        {
          "amount": "3.14"
        }
      ],
      "clientEntityId": "a3f1b2c4-d5e6-7890-abcd-ef1234567890",
      "groupId": "9c0f1c0d-6c61-4f3d-9b8a-1a3a4b3c5d6e"
    }
  ]
}

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.

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"

​
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.

Some collections have a strict upper bound that will disregard this value. In case the specified value is higher than the allowed limit, the collection limit will be used.

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

Required range: x >= 1
Example:

5

Response

Successfully retrieved a list of accounts.

​
data
object[]