Skip to main content
GET
List rewards

GET /rewards

Retrieve the account’s points reward catalog. Send Authorization: Bearer YOUR_API_KEY and X-Device-ID: YOUR_DEVICE_ID. See authentication. The response is an array of reward definitions. To display rewards configured for a points card, match these ids against card.program.rewardIds, or use public card rewards. pointsNeeded is the cost to redeem. cooldownHours is an integer from 0 to 8760; 0 disables cooldowns. This catalog does not include per-card cooldown timestamps.

Example request

Example response

Authorizations

Authorization
string
header
required

Location API key. Also requires X-Device-ID.

Headers

X-Device-ID
string
required

Stable device identifier. API key binds to this value on first use.

Response

Success

id
string

MongoDB object id.

Pattern: ^[a-fA-F0-9]{24}$
pocketId
string
name
string
description
string
pointsNeeded
integer
Required range: x >= 1
cooldownHours
integer

Cooldown per card and reward; 0 disables it.

Required range: 0 <= x <= 8760