v1

latestOpenAPI 3.0.12026-07-24210349345.4 KB
Player Profile

Player Profile

Display name and avatar for the logged-in player.

get/player-profiles/brand/{brandId}/player/{playerId}

Path parameters

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.

Response

Player profile.

idstring uuid

Internal UUID for this player profile (distinct from playerId).

namestring

Display name shown in the widget header and leaderboards.

iconstring nullable

URL to the player's avatar image. Render as-is or proxy through your CDN.