Contacts
List contacts
Returns a paginated list of contacts (end-customers, excluding organization members).
Filtering:
- `search` — case-insensitive substring match on email, name, phone, and externalId.
- `templateId` — restrict to contacts who own a wallet pass for this stamp card template.
- `minStamps` / `maxStamps` — inclusive range filter on the current stamp count of that
pass. Requires `templateId`.
- `includeStamps` — embed per-pass stamp progress on each contact. Automatically enabled
when a stamp filter is active.
Sorting defaults to `createdAt` descending. Page size is capped at 200.
Required scopes: user:read
AuthorizationBearer <token>
Sign in with your account. A temporary API token is generated automatically for the selected organization.
In: header
Query Parameters
search?string
Case-insensitive match on email, name, phone, externalId.
templateId?string
Stamp card template ID (e.g. tmpl_...). Required when using minStamps/maxStamps.
minStamps?integer
Inclusive lower bound on currentStamps. Requires templateId.
Format
int32maxStamps?integer
Inclusive upper bound on currentStamps. Requires templateId.
Format
int32includeStamps?boolean
When true, include per-pass stampProgress on each contact.
Default
falsepageable*
Response Body
*/*
curl -X GET "https://api.stemp.app/api/v1/contacts?page=0&size=1&sort=string"{
"content": [
{}
],
"page": {
"size": 0,
"number": 0,
"totalElements": 0,
"totalPages": 0
}
}