This endpoint returns a customer record. Most commonly used to fetch a customer’s point balance and unique referral link.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Please note:When using the “with_history” 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 uses, 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 },
points_expire_at
points_expire_atThe response includes points_expire_at: the date when the customer's points are set to expire, or null when points never expire under your policy. The value follows your Points expiration policy (Last Activity, Date Earned, or Never expire). For Date Earned, the field is the next upcoming expiration across batches (not every batch date). The same field and rules apply to GET /v1/customers, GET /v2/customers, and list responses from GET /api/v2/customers/recent. For the full description, see any webhook that returns a customer object with this field—for example Points Earned.
yotpo_customer_id
yotpo_customer_idThe response includes yotpo_customer_id: the customer's internal Yotpo Loyalty ID (integer). It is the same ID shown in the customer page URL in the Loyalty admin, so you can retrieve it programmatically instead of looking it up in the admin. Use it with Loyalty APIs that identify the customer by internal ID. The field is also returned for each customer by GET /api/v2/customers/recent.