List end users

List end users

curl --request GET \
  --url https://api.cdp.coinbase.com/platform/v2/end-users \
  --header 'Authorization: Bearer <token>'

{
  "endUsers": [
    {
      "userId": "e051beeb-7163-4527-a5b6-35e301529ff2",
      "authenticationMethods": [
        {
          "type": "email",
          "email": "[email protected]"
        },
        {
          "type": "sms",
          "phoneNumber": "+12055555555"
        },
        {
          "type": "jwt",
          "sub": "e051beeb-7163-4527-a5b6-35e301529ff2",
          "kid": "NjVBRjY5MDlCMUIwNzU4RTA2QzZFMDQ4QzQ2MDAyQjVDNjk1RTM2Qg"
        },
        {
          "type": "google",
          "sub": "115346410074741490243",
          "email": "[email protected]"
        }
      ],
      "evmAccounts": [
        "0x742d35Cc6634C0532925a3b844Bc454e4438f44e"
      ],
      "evmSmartAccounts": [
        "0x742d35Cc6634C0532925a3b844Bc454e4438f44e"
      ],
      "solanaAccounts": [
        "HpabPRRCFbBKSuJr5PdkVvQc85FyxyTWkFM2obBRSvHT"
      ],
      "createdAt": "2025-01-15T10:30:00Z"
    }
  ],
  "nextPageToken": "eyJsYXN0X2lkIjogImFiYzEyMyIsICJ0aW1lc3RhbXAiOiAxNzA3ODIzNzAxfQ=="
}

GET

end-users

List end users

curl --request GET \
  --url https://api.cdp.coinbase.com/platform/v2/end-users \
  --header 'Authorization: Bearer <token>'

{
  "endUsers": [
    {
      "userId": "e051beeb-7163-4527-a5b6-35e301529ff2",
      "authenticationMethods": [
        {
          "type": "email",
          "email": "[email protected]"
        },
        {
          "type": "sms",
          "phoneNumber": "+12055555555"
        },
        {
          "type": "jwt",
          "sub": "e051beeb-7163-4527-a5b6-35e301529ff2",
          "kid": "NjVBRjY5MDlCMUIwNzU4RTA2QzZFMDQ4QzQ2MDAyQjVDNjk1RTM2Qg"
        },
        {
          "type": "google",
          "sub": "115346410074741490243",
          "email": "[email protected]"
        }
      ],
      "evmAccounts": [
        "0x742d35Cc6634C0532925a3b844Bc454e4438f44e"
      ],
      "evmSmartAccounts": [
        "0x742d35Cc6634C0532925a3b844Bc454e4438f44e"
      ],
      "solanaAccounts": [
        "HpabPRRCFbBKSuJr5PdkVvQc85FyxyTWkFM2obBRSvHT"
      ],
      "createdAt": "2025-01-15T10:30:00Z"
    }
  ],
  "nextPageToken": "eyJsYXN0X2lkIjogImFiYzEyMyIsICJ0aW1lc3RhbXAiOiAxNzA3ODIzNzAxfQ=="
}

Authorizations

Authorization

string

header

required

A JWT signed using your CDP API Key Secret, encoded in base64. Refer to the Generate Bearer Token section of our Authentication docs for information on how to generate your Bearer Token.

Query Parameters

pageSize

integer

default:20

The number of end users to return per page.

Required range: 1 <= x <= 100

pageToken

string

The token for the desired page of end users. Will be empty if there are no more end users to fetch.

sort

enum<string>[]

Sort end users. Defaults to ascending order (oldest first).

Available options:

createdAt=asc,

createdAt=desc

Response

Successfully retrieved end users.

endUsers

object[]

required

The list of end users.

Show child attributes

endUsers.userId

string

required

A stable, unique identifier for the end user. The userId must be unique across all end users in the developer's CDP Project. It must be between 1 and 100 characters long and can only contain alphanumeric characters and hyphens.

Example:

"e051beeb-7163-4527-a5b6-35e301529ff2"

endUsers.authenticationMethods

(EmailAuthentication · object | SmsAuthentication · object | DeveloperJWTAuthentication · object | OAuth2Authentication · object)[]

required

The list of valid authentication methods linked to the end user.

Information about how the end user is authenticated.

EmailAuthentication
SmsAuthentication
DeveloperJWTAuthentication
OAuth2Authentication

Show child attributes

endUsers.authenticationMethods.type

enum<string>

required

The type of authentication information.

Available options:

email

Example:

"email"

endUsers.authenticationMethods.email

string<email>

required

The email address of the end user.

Example:

"[email protected]"

Example:

[
  {
    "type": "email",
    "email": "[email protected]"
  },
  {
    "type": "sms",
    "phoneNumber": "+12055555555"
  },
  {
    "type": "jwt",
    "sub": "e051beeb-7163-4527-a5b6-35e301529ff2",
    "kid": "NjVBRjY5MDlCMUIwNzU4RTA2QzZFMDQ4QzQ2MDAyQjVDNjk1RTM2Qg"
  },
  {
    "type": "google",
    "sub": "115346410074741490243",
    "email": "[email protected]"
  }
]

endUsers.evmAccounts

string[]

required

The list of EVM accounts associated with the end user. Currently, only one EVM account is supported per end user.

The address of the EVM account associated with the end user.

Example:

[
  "0x742d35Cc6634C0532925a3b844Bc454e4438f44e"
]

endUsers.evmSmartAccounts

string[]

required

The list of EVM smart accounts associated with the end user. Currently, only one EVM smart account is supported per end user.

The address of the EVM smart account associated with the end user.

Example:

[
  "0x742d35Cc6634C0532925a3b844Bc454e4438f44e"
]

endUsers.solanaAccounts

string[]

required

The list of Solana accounts associated with the end user. Currently, only one Solana account is supported per end user.

The base58 encoded address of the Solana account associated with the end user.

Example:

[
  "HpabPRRCFbBKSuJr5PdkVvQc85FyxyTWkFM2obBRSvHT"
]

endUsers.createdAt

string<date-time>

required

The date and time when the end user was created, in ISO 8601 format.

Example:

"2025-01-15T10:30:00Z"

nextPageToken

string

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

Example:

"eyJsYXN0X2lkIjogImFiYzEyMyIsICJ0aW1lc3RhbXAiOiAxNzA3ODIzNzAxfQ=="

Get an end user

Create an end user

⌘I

CDP API V2

REST API

Authorizations

Query Parameters

Response