Sign in

v1

latestOpenAPI 3.1.02026-07-26620219.6 KB

Retrieve Customers

Retrieve a list of past and existing customers as they appear in Yotpo.

get/core/v3/stores/{store_id}/customers

Path parameters

store_idstring required

The store ID (app_key).

Query parameters

access_tokenstring required

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

page_infostring

Encoded page info.

limitinteger

Defines how many results will be returned per page. Can be any number between 1 and 100.

external_idsstring

Return only entities specified by a comma-separated (without spaces) list of external IDs. The argument must be <a href="https://www.urlencoder.io/learn" target="_blank">URL encoded</a>. Max 100 IDs. Can't come with page_info or limit.

expandstring

Flag for Yotpo product information to be included in the response. Choose one or several of the following: reviews, loyalty, or all. For example "loyalty". Defaults to "all"

emailstring

The customer’s email address. Special characters should be encoded.

phone_numberstring

The customer’s phone number. Should be E.164 format, for example +11231234567. Phone number is not a unique identifier — multiple customers may share a phone number.

updated_at_minstring date

Retrieve all customer details updated from this date. The date format is YYYY-MM-DD

Response

200

OR

Example response

{
  "customers": [
    {
      "external_id": "ak123798684365sdfkj",
      "email": "tom.smith@hostname.com",
      "phone_number": "+14155552671",
      "first_name": "Tom",
      "last_name": "Smith",
      "gender": "M",
      "account_created_at": "2020-09-08T08:43:27Z",
      "account_updated_at": "2023-02-01T08:43:27Z",
      "yotpo_ugc": {
        "total_reviews": 1,
        "avg_product_rating": 4,
        "total_avg_rating": 4,
        "sentiment_avg_product": 0.764,
        "total_avg_sentiment": 0.764,
        "top_topics": [
          "5 stars"
        ],
        "last_star_rating": 4,
        "last_review_date": "2023-06-24T08:43:27Z",
        "last_sentiment": 0.86
      },
      "yotpo_loyalty": {
        "points_earned": 2500,
        "points_balance": 3500,
        "last_seen_at": "2023-02-01T08:43:27Z",
        "total_redemptions": 10,
        "total_points_redeemed": 2000,
        "vip_tier_name": "Gold",
        "successful_referrals": 3,
        "referrals_made_and_clicked": 5,
        "is_referred_by_other_customer": true,
        "points_expire_date": "2022-12-31T08:43:27Z",
        "credit_balance_amount": 100,
        "credit_balance_customer_currency": "₪340",
        "is_opt_in": true,
        "opt_in_date": "2023-01-15T08:43:27Z",
        "has_store_account": true,
        "referred_by_customer": "john@doe.com",
        "vip_entry_date": "2022-07-01T08:43:27Z",
        "vip_expiration_date": "2023-06-30T08:43:27Z"
      }
    }
  ]
}