Get paginated list of customers with filters

get

https://sandbox-api.heypongo.com/v1/customers

Required scopes:

customer.read

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

international_phone_number

string

Filter customers by international phone number.

first_name

string

Filter customers by first name.

last_name

string

Filter customers by last name.

string

Filter customers by email.

loyalty_card_number

string

Filter customers by loyalty card number (exact match). The loyalty card number, when specified, comes from a previous loyalty system and not from HeyPongo. HeyPongo identifiers are the cust_id.

page_size

integer

The number of items per page. Default: 100

page

integer

The page number. Default: 1

updated_at_after

string

Filter customers updated after a certain date.

updated_at_before

string

Filter customers updated before a certain date.

Body Params

international_phone_number

string | null

loyalty_card_number

string | null

first_name

string | null

last_name

string | null

Must be a valid email address.

updated_at_before

string | null

updated_at_after

string | null

page

integer | null

Must be at least 1.

page_size

integer | null

Must be at least 1. Must not be greater than 1000.

Response

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200