Retrieve Customer Details by Email

Retrieve details for a specific customer for Yotpo Reviews and Yotpo Loyalty & Referrals.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
🚧

Deprecation notice

This endpoint is deprecated and will be removed in a future release. Please discontinue use and migrate any existing integrations as soon as possible. Once removed, requests to this endpoint will no longer be accepted.

🚧

Please note:

This endpoint uses old infractructure and cannot support a large number of customers. We recommend using the Retrieve Products endpoint, which is built on top of new infrastructure and is fully supported by Yotpo.

Customer By Email - Response Attributes

AttributesDescription
customer_emailThe customer’s email address
total_reviewsThe total number of reviews submitted by the customer
avg_product_ratingThe average star rating of all product reviews
avg_site_ratingThe average star rating of all site reviews
total_avg_ratingThe average star rating of all review types
avg_sentiment_productThe average sentiment for product reviews
avg_sentiment_siteThe average sentiment for site reviews
total_avg_sentimentThe total average sentiment for all review types
top_topicsAn array of top topics of interest
points_earnedThe total sum of points the customer earned in their lifetime
point_balanceThe current point balance for the customer
total_redemptionsThe number of points that were redeemed for discounts in the customer's lifetime
total_points_redeemedThe number of times the customer redeemed points in their lifetime
vip_tier_nameThe name of the tier the customer currently belongs to
successful_referralsThe number of successful referrals made by the customer
referrals_made_and_clickedThe number of times this customer's referral link was clicked by referred customers
is_referred_by_other_customerIndicates if this customer was referred by a different customer
📘

Please note:

  • Data is refreshed in real-time.
  • This endpoint does not contain imported reviews or anonymous reviews (reviews that were submitted on-site without the customer confirming their email address).
  • You may have to add additional params to query the following fields: avg_sentiment_product, avg_sentiment_site, total_avg_sentiment, top_topics.
Path Params
string
required

Your account's API app key

Query Params
string
required

Your Yotpo access token. Click here to learn how to generate one

string
required

The customer’s email address

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Choose an example:
application/json
text/plain