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.

👍

How to use this endpoint

  • Required parameters are listed below. For the full list of properties, see About customers.
  • For example requests, see below.
  • For example responses, click the relevant status code on the right.
  • To pull custom customer properties, make sure to set the 'include_custom_properties' query parameter to 'true'.

Example requests

GET /v3/stores/{store_id}/customers

GET /v3/stores/{store_id}/customers?page_info={page_info}

GET /v3/stores/{store_id}/customers?page_info={page_info}&limit={limit}

GET /v3/stores/{store_id}/customers?external_ids=ext1,ext2

GET /v3/stores/{store_id}/customers?include_custom_properties=true

📘

Good to know

It can take up to one minute for a customer's details to be created or updated in Yotpo.

Language