API Reference
UGC APILoyalty APIApp Developer APIHelp Center

Retrieve customers

get
https://api.yotpo.com/core/v3/stores/store_id/customers

Retrieves a list of past and existing customers from your Yotpo store. Use this endpoint to check if a customer was registered successfully with Yotpo.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The store ID (app_key).

Query Params
string

Encoded page info.

int32

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

string

Return only entities specified by a comma-separated (without spaces) list of external IDs. The argument must be URL encoded. Max 100 IDs. Can't come with page_info or limit.

boolean

The custom customer properties that enrich the customer profile. For example, skin type, hair color, etc.

string

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

string

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

string

The customer’s phone number. Should be E.164 format, for example +11231234567.

date

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

string

Return only entities specified by a comma-separated (without spaces) list of List IDs

Responses

Updated 11 months ago

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json

Updated 11 months ago