v1

latestOpenAPI 3.0.12026-07-24210349345.4 KB

Rewards

Brand Rewards Catalog

All reward types configured for the brand. Cross-reference rewardTypeId from player rewards, mission rewards, and leaderboard prizes against this list to get names and icons.

The catalog changes infrequently. Cache it for the widget session lifetime and re-fetch on the next page load.

get/rewards/brand/{brandId}

Path parameters

brandIdstring uuid required

Example:aebb6a6a-bdef-480f-8096-e13f9c3d4969

Brand UUID returned by GET /brands/default/{tenantId}.

Response

Array of reward types.

idstring uuid

UUID of this reward type. Matches rewardTypeId in player rewards and mission reward items.

namestring

Display name (e.g. "Gold Coin", "VIP Badge").

descriptionstring nullable

Optional description of the reward.

type'currency' | 'progression' | 'badge' | 'additional'

currency (spendable balance), progression (XP/level point), badge (collectible), or additional (custom reward identified by shortCode for downstream fulfillment).

iconstring nullable

URL to the reward icon.

tag'common' | 'rare' | 'epic' | 'legendary'

Rarity tier. Use to apply visual styling.

shortCodestring nullable

Optional short code identifying the reward. Sent in the webhook payload when an additional-type reward is claimed, so you can map it to downstream fulfillment systems. null for other reward types or when not configured.

tenantIdinteger

brandIdstring uuid

createdAtstring date-time

updatedAtstring date-time

Example response

[
  {
    "shortCode": "BONUS-100"
  }
]