Get User

Get details of the user. Refer to this article for the authentication flow when calling this API from a storefront or client side environment.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

(Required) (This needs to be leads _id value) (If need to get user via customer id pass any random uuid v4 value for id)

Query Params
string

(Minimum length is 8) (Maximum length is 128) (This needs to be leads customer_id value) (If this value is passed, it will be given first preference while searching user)

string

(This needs to be leads referral_code value) (If this value is passed, it will be given second preference while searching user)

string

(This needs to be leads email value) (If this value is passed, it will be given third preference while searching user)

string

(This needs to be leads mobile value) (If this value is passed, it will be given fourth preference while searching user)

Headers
string
required

(Required) (This can only be one of mobile,unix,web)

string
required

(Required) (This needs to be your apikey)

string
required

(Required) (This needs to be your workspaceid)

number

(Required when sending x-leaddigest) (Unix timestamp in seconds — must match the timestamp used to compute the x-leaddigest; valid within ±60 minutes of server time when digest is present)

string

(Required when using a Storefront read API key without a lead token) (HMAC-SHA256 of "customer_id:timestamp" signed with your API signing secret, hex-encoded — a lead_token is returned in the response — Learn more about authentication here)

string

(Required when using a Storefront read API key) (Learn more about authentication here)

Response
200

200

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here!