v1

latestOpenAPI 3.0.12026-07-24210349345.4 KB

Player Rewards

Player Badges

Returns the badges (rewards with type = "badge") earned by the player.

get/player-rewards/brand/{brandId}/player/{playerId}/badges

brandIdstring uuid required

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

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

playerIdstring required

Example:player-123

Your internal player/customer identifier.

Array of badges earned by the player.

idstring uuid

UUID of the badge (matches reward catalog id).

namestring

Badge display name.

descriptionstring nullable

What the player did to earn this badge.

type'badge'

Always badge for this endpoint.

iconstring nullable

URL to the badge image.

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

Rarity tier. Use to apply visual treatment.

shortCodestring nullable

Present on the underlying reward record. Typically null for badges; populated only for additional-type rewards.

tenantIdinteger

brandIdstring uuid