Get User

get

https://platform.nector.io/api/v2/merchant/leads/{id}

Get details of the user including the wallet balance, tier, membership and referral code. Look up by lead id in the path. To look up by customer_id, referral_code, email or mobile instead, pass any placeholder uuidv4 in the path (the path id is always required to keep the API strict) and pass the lookup key in the query, the query value takes precedence. email and mobile are masked in the response. When looked up by email, mobile or referral_code with a read only api key, the response omits id, customer_id, wallet_id and creditwallet_id so that a visitor cannot discover another customer's ids, use customer_id or the path id (or a write api key) to get them. When called with a storefront read only api key and x-leaddigest, the response also carries lead_token, a 1 hour token identifying this customer, which every customer scoped API accepts in the x-leadtoken header so the customer id never has to be trusted from the browser. Refer to this article for the authentication flow when calling this API from a storefront or client side environment.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

uuid

required

(Required) (This needs to be leads _id value) (The path id is always required to keep the API strict. When looking up by customer_id, referral_code, email or mobile instead, pass any placeholder uuidv4 here and pass the lookup key in the query, the query value takes precedence)

Query Params

customer_id

string

(Minimum length is 8) (Maximum length is 128) (This needs to be leads customer_id value) (Alternative to the path id. Lookup keys are checked in the order customer_id, referral_code, email, mobile, then the path id)

referral_code

string

(This needs to be leads referral_code value) (Alternative to the path id, checked after customer_id)

string

(This needs to be leads email value) (Alternative to the path id, checked after customer_id and referral_code)

mobile

string

(This needs to be leads mobile value) (Alternative to the path id, checked after customer_id, referral_code and email)

Headers

x-source

string

enum

required

(Required) (This can only be one of mobile,web) (web for browsers and servers, mobile for native apps)

Allowed:

x-apikey

string

required

(Required) (This needs to be your apikey)

x-workspaceid

string

required

(Required) (This needs to be your workspaceid)

x-timestamp

number

(Required when x-leaddigest is passed, optional otherwise) (Unix timestamp in seconds, the same value used while computing x-leaddigest) (Must be within 60 minutes of the server time when x-leaddigest is passed, within 2 minutes otherwise) (Defaults to the server time when omitted)

x-leaddigest

string

(Alternative to x-leadtoken for this API only, when using a storefront read only api key) (Hex encoded HMAC-SHA256 of the string customer_id:x-timestamp, signed with your api signing secret, computed on your server) (Pass the same customer_id in the query) (A platform prefix on the customer id, one of shopify-, woocommerce-, magento-, custom_website-, is stripped before computing the digest, ex. for customer_id shopify-12345 sign 12345:x-timestamp) (The response then carries lead_token, use it in x-leadtoken on all other customer scoped APIs) (Learn more about authentication here)

x-leadtoken

string

(Required when using a storefront read only api key, not needed with a server api key) (This needs to be the lead_token of the customer, a 1 hour JWT returned by Get User via the x-leaddigest flow or generated on your server with your api signing secret) (When passed, the customer is taken from the token and any lead_id or customer_id in the request is ignored) (Learn more about authentication here)

Responses

200200

5XXUnexpected error on our side. Retry with backoff and share meta.request_id with [email protected] if it persists