Get user details by uid

🚧

Important:

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

Get user details by uid

Endpoint

GET /user/{uid}

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

Parameters

Path parameters

Path parameterDescription
uidThe unique identifier of the user for this app (ex. 816379099131).

Response

You will receive the user details including the following fields:

Response fieldsTypeDescriptionCondition
uidStringThe user UID.Mandatory
created_atString
(Timestamp)
The timestamp of the user creation.Mandatory
emailString
(Email)
The user email.Can be null
user_external_idStringThe unique ID by which you identify this user in your system.Can be null
wallet_addressStringThe user wallet address.Can be null
client_idStringThis field has been deprecated. You should now use user_external_idDeprecated

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",
    "wallet_address": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
    "client_id": "user_external_id_1" // Deprecated - use user_external_id
  }
}

πŸ“˜

Note:

Considering that user wallet creation is asynchronous, the wallet_address will be empty until it is created. See Create User for more information.

Example

The following example gets the user details for uid 222222222222.

# 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/user/222222222222"