Skip to main content
GET
List shoppers

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

ending_before
string

Return records that precede the record with this ID, in list order.

enrolled_in_loyalty_program
boolean

Whether the shopper is enrolled in the loyalty program.

limit
integer
default:20

Maximum number of records to return.

Required range: 1 <= x <= 100
phone_number
string

Phone number on file for the shopper. Matched exactly.

Maximum string length: 255
starting_after
string

Return records that follow the record with this ID, in list order.

Response

data
object[]
required
has_more
boolean
required

Whether more records follow this page.