Sign in
Accounts

List accounts

Changed on

List all accounts. The API will return all accounts that the API Key has Permissions to access. You can filter the results by using query parameters, which will be treated as a single conjunction (i.e. AND). Results are sorted by creation date in descending order (newest first).

get/v2/accounts

Request

  • Base URL: https://api.cdp.coinbase.com/platform
  • URL: https://api.cdp.coinbase.com/platform/v2/accounts
  • Auth: HTTP bearer

Query parameters

pageSizeinteger

The number of resources to return per page.

pageTokenstring

The token for the next page of resources, if any.

ownerstring[]

Filter accounts by owner. Values can be specific Owner IDs or owner type wildcards. Multiple values can be combined as a comma-separated list.

Specific Owner IDs:

  • entity_<uuid> - Accounts owned by a specific entity
  • customer_<uuid> - Accounts owned by a specific customer

Owner type wildcards:

  • entity - All entity-owned accounts
  • customer - All customer-owned accounts

Examples:

  • owner=customer_af29... - A specific customer's accounts
  • owner=customer - All customer accounts
  • owner=entity,customer_af29... - Entity accounts and a specific customer's accounts
  • When omitted, accounts with any owner are returned.
type'prime' | 'business' | 'cdp'

The type of the Account.

  • prime: a linked Coinbase Prime account.
  • business: a linked Coinbase Business account.
  • cdp: a CDP-native account created via this API. Used for accounts created on behalf of an Entity and for Customer-owned accounts.
Example:prime

Filter accounts by account type. When omitted, accounts of any type are returned. Combined with owner using AND.

Response

Successfully listed accounts.

nextPageTokenstring

The token for the next page of items, if any.

Example response

{
  "accounts": [
    {
      "accountId": "account_af2937b0-9846-4fe7-bfe9-ccc22d935114",
      "type": "prime",
      "owner": "entity_af2937b0-9846-4fe7-bfe9-ccc22d935114",
      "name": "My Business Account",
      "createdAt": "2023-10-08T14:30:00Z",
      "updatedAt": "2023-10-08T14:30:00Z"
    }
  ],
  "nextPageToken": "eyJsYXN0X2lkIjogImFiYzEyMyIsICJ0aW1lc3RhbXAiOiAxNzA3ODIzNzAxfQ=="
}

Changes

  • 156440e9f8dfRevision changes
    • warning

      added the new incompatible_event_types enum value to the response property for the response status

    • warning

      added the new invalid_webhook_headers enum value to the response property for the response status

    • warning

      added the new invalid_webhook_url enum value to the response property for the response status

    • warning

      added the new mandate_action_pending enum value to the response property for the response status

    • warning

      added the new mandate_canceled enum value to the response property for the response status

    • warning

      added the new mandate_expired enum value to the response property for the response status

    • warning

      added the new mandate_invalid_status enum value to the response property for the response status

    • warning

      added the new mandate_policy_violation enum value to the response property for the response status

    • warning

      added the new mandate_revoked enum value to the response property for the response status

    • warning

      added the new subscription_limit_exceeded enum value to the response property for the response status

  • 229ed860a74bRevision changes
    • warning

      added the new mfa_challenge_not_found enum value to the response property for the response status

    • warning

      added the new operation_in_progress enum value to the response property for the response status