Skip to main content
GET
The response includes the customer’s current VIP tier and loyalty membership status. To fetch many customers at once, use List customers.
Requires the read:customers scope. The points, referral_code/referral_url and tier fields are only included when the key also has the points, referrals and tiers scopes. See Scopes.

Path parameters

string
required
The customer’s phone number, ideally in international format (for example +14155552671). Spaces, dashes and brackets are ignored, and the number matches with or without the leading +. URL-encode it (for example + becomes %2B).

Response

object
The customer. Has the properties of the Customer object, plus tier and membership. Some fields depend on the key’s other scopes, as noted below.

Errors