GET/api/v2/loyalty/user-balance

Get point balance for the authenticated user

Authentication

Send your API key in the x-api-key header on every request.

Responses

200 — OK

Response 200 fields
FieldTypeRequiredDescription
UserIdunknownNo
ProgramIdunknownNo
CurrentBalanceunknownNo
TotalEarnedunknownNo
TotalRedeemedunknownNo
TierLevelstringNo
LastActivitystring (date-time)No
EnrolledAtstring (date-time)No
MonthlyStatsobjectNo

401 — Unauthorized

Response 401 fields
FieldTypeRequiredDescription
MessagestringNo
CodestringNo
StatusunknownNo
ValidationErrorsobjectNo
DetailsstringNo

500 — Internal Server Error

Response 500 fields
FieldTypeRequiredDescription
MessagestringNo
CodestringNo
StatusunknownNo
ValidationErrorsobjectNo
DetailsstringNo

Example request

curl -X GET "https://{base_url}/api/v2/loyalty/user-balance" \
  -H "x-api-key: YOUR_API_KEY"

This page is generated from the live OpenAPI specification and always matches the current API.