GET/api/v2/loyalty/user/dashboard

Get comprehensive user dashboard data with auto-enrollment

Authentication

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

Responses

200 — OK

Response 200 fields
FieldTypeRequiredDescription
PointBalanceUserPointBalanceResponseNo
RecentTransactionsarray of PointTransactionResponseNo
RedemptionOptionsarray of RedemptionOptionResponseNo
StatsUserLoyaltyStatsResponseNo
ProgramLoyaltyProgramResponseNo
GeneratedAtstring (date-time)No

401 — Unauthorized

Response 401 fields
FieldTypeRequiredDescription
MessagestringNo
CodestringNo
StatusunknownNo
ValidationErrorsobjectNo
DetailsstringNo

404 — Not Found

Response 404 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/dashboard" \
  -H "x-api-key: YOUR_API_KEY"

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