GET
/api/v2/loyalty/balancesGet point balances for all users (admin view)
Authentication
Send your API key in the x-api-key header on every request.
Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| limit (query) | unknown | No | Maximum number of balances to return |
| offset (query) | unknown | No | Number of balances to skip |
Responses
200 — OK
| Field | Type | Required | Description |
|---|---|---|---|
| UserId | unknown | No | |
| ProgramId | unknown | No | |
| CurrentBalance | unknown | No | |
| TotalEarned | unknown | No | |
| TotalRedeemed | unknown | No | |
| TierLevel | string | No | |
| LastActivity | string (date-time) | No | |
| EnrolledAt | string (date-time) | No | |
| MonthlyStats | object | No |
401 — Unauthorized
| Field | Type | Required | Description |
|---|---|---|---|
| Message | string | No | |
| Code | string | No | |
| Status | unknown | No | |
| ValidationErrors | object | No | |
| Details | string | No |
500 — Internal Server Error
| Field | Type | Required | Description |
|---|---|---|---|
| Message | string | No | |
| Code | string | No | |
| Status | unknown | No | |
| ValidationErrors | object | No | |
| Details | string | No |
Example request
curl -X GET "https://{base_url}/api/v2/loyalty/balances" \
-H "x-api-key: YOUR_API_KEY"This page is generated from the live OpenAPI specification and always matches the current API.