Skip to main content
GET
Get customer points balance

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.

Path Parameters

id
string
required

Unique identifier for this customer.

Response

Summary of a customer's loyalty points balance, including earned, spent, and current tier.

customer_id
string
required
points_balance
integer
required
points_earned
integer
required
points_spent
integer
required
points_name
string
required
last_activity_date
string<date-time> | null
required
tier
string
required