Skip to main content
GET
List customers

Authorizations

Authorization
string
header
default:your_token_here
required

Restaurant-scoped partner API token passed as Authorization: Bearer <token>.

Query Parameters

updated_since
string<date-time>

Only customers created or modified at or after this instant. Combine with cursor for an incremental sync.

email
string<email>

Filter by email address (case-insensitive exact match).

phone
string

Filter by phone number. National and international spellings of the same number match.

Minimum string length: 1
external_id
string

Filter by the partner-side identifier.

Minimum string length: 1
tag
string

Only customers carrying this tag (exact match).

Minimum string length: 1
cursor
string

pagination.next_cursor of the previous page.

Minimum string length: 1
limit
integer
default:50

Number of customers per page, from 1 to 100.

Required range: 1 <= x <= 100

Response

One page of customers

data
object[]
required
pagination
object
required