Skip to main content
GET
Search and list customers

Authorizations

X-API-Key
string
header
required

Per-company partner API key (zupy_pk_…). Validated by Zupy against the company integration key hash (Story 14.x); send it on every request as the X-API-Key header. Scoped read-write to the owning company's data.

Query Parameters

card_code
string

Filter by card number/code (case-insensitive contains)

cursor
string

Pagination cursor value from previous response.

email
string

Filter by email address (case-insensitive contains)

name
string

Filter by customer name (case-insensitive contains)

page_size
integer

Number of results to return per page.

phone
string

Filter by phone number (digits only, case-insensitive contains)

General text search across name, email, phone, and card code

segment
string

Filter by RFM segment (champions, loyal, promising, at_risk, new)

tier
string

Filter by loyalty tier (exact match: default, bronze, silver, gold, platinum, vip)

Response

data
object[]
required
meta
object
required