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

📘

Please note:

When using the “withhistory” flag set to true, the _completed_at value returned with the customer's history items represents the created_at date passed with the Custom Action API call. This registers when the customer actually completed the action, and not when it was registered in the Yotpo system.

🚧

Please note:

If you're a Shopify merchants who has Yotpo SMS & Email, Klaviyo, or a custom ESP integration and joined Yotpo Loyalty & Referrals after August 2024, you will get a response with the following details for the “with_referral_code” parameter:
"referal_link{
"link": "rwrd.io/abc123"
"code":"abc123"
"expired":false },

Language
Click Try It! to start a request and see the response here!