Get user details by email

🚧
Important:
Request headers are required. See API basics introduction for more information.

Get user details by email

Endpoint

GET /user?email={email}

Returns the user details for a given email associated with the given App (set by the X-API-KEY).

Parameters

Query parameters

Query parameter	Description
`email`	The email address supplied when first creating the user associated with this app (ex: [email protected]).

Response

You will receive the user details including the following fields:

Response fields	Type	Description	Condition
`uid`	String	The user UID.	Mandatory
`created_at`	String (Timestamp)	The timestamp of the user creation.	Mandatory
`email`	String (Email)	The user email.	Mandatory
`user_external_id`	String	The unique ID by which you identify this user in your system.	Can be null
wallets	List[wallet]	see below
`client_id`	String	This field has been deprecated. You should now use `user_external_id`.	Deprecated

Response wallet fields	Type	Description	Condition
`address`	String	The wallet address.	Mandatory
`explorer_url`	String	The explorer URL (PolygonScan) of the wallet.	Mandatory
`network`	String (Email)	The wallet network (Polygon \| Solana).	Mandatory
`chain_id`	Number	The wallet chain id when EVM (Polygon \| Amoy).	Optional

Response example

{
  "success": true,
  "data": {
    "uid": "816379099131",
    "created_at": "2023-08-10T14:07:14.494142Z",
    "email": "[email protected]",
    "user_external_id": "user_external_id_1",
    "wallets": [{
      "address": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
      "explorer_url": "https://amoy.polygonscan.com/address/0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
      "network": "Polygon",
      "chain_id": 80002}
      ],
    "client_id": "user_external_id_1" // Deprecated - use user_external_id
  }
}

📘
Note:
Considering that user wallet creation is asynchronous and delayed at the first on-chain usage (mint or deposit), wallets or address might be empty until wallets are created. See Create User for more information.

Example

The following example gets the user details for email [email protected].

# API_KEY is your api key
# TOKEN is the access token generated with your api key secret

curl -i \ 
  -X GET \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: API_KEY" \
  -H "Authorization: Bearer TOKEN" \
  "https://api.getoriginal.com/v1/[email protected]"

Updated 8 days ago