Retrieve Customers

get

https://developers.yotpo.com/core/v3/stores/store_id/customers

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

store_id

string

required

The store ID (app_key).

Query Params

access_token

string

required

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

page_info

string

Encoded page info.

limit

int32

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

external_ids

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.

include_custom_properties

boolean

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

expand

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.

phone_number

string

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

updated_at_min

date

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

list_ids

string

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

segment_id

string

Returns all the customers from a specified. You can receive information about one segment each time a request is made to the endpoint.

Responses

Language

Credentials

OAuth2

Loading…

Response

Choose an example:

application/json

200200

400400