Fetch Customer Details

get

https://loyalty.yotpo.com/api/v2/customers

This endpoint returns a customer record. Most commonly used to fetch a customer’s point balance and unique referral link.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

customer_email

string

required

The customer's email address. Required if no pos_account_id, customer_id or phone_number is passed.

customer_id

string

required

The identifier used to uniquely identify the customer in your system. Required if no customer_email, pos_account_id or phone_number is passed.

pos_account_id

string

required

The identifier used to uniquely identify the customer in your POS system. Required if no customer_email, customer_id or phone_number is passed.

phone_number

string

required

The customer's phone number in E.164 format. e.g +14155552671. Must be an exact match. Required if no customer_email, pos_account_id or customer_id or is passed.

country_iso_code

string

Defaults to null

Only use if unable to send phone_number in full E.164 format. If phone_number is passed in full E.164 format with country_iso_code, this string will be ignored. Example: "US", "GB", i.e.

with_referral_code

boolean

Defaults to false

Defaults to false. If you'd like information about the customers referral code you can set this to true.

with_history

boolean

Defaults to true

Defaults to false. If you'd like information about the customers point earning and redemption history you can set this to true.

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400