Sign in

v1

latestOpenAPI 3.0.12026-07-24210349345.4 KB
Leaderboards

List Leaderboards for a Brand

All leaderboards and tournaments configured for the brand, including prize tiers, period dates, and reset cadence.

For repeatable leaderboards, when a period ends the current instance moves to rewarding, then archived, and a new active instance appears in the list automatically.

get/leaderboards/brand/{brandId}

Path parameters

brandIdstring uuid required
Example:aebb6a6a-bdef-480f-8096-e13f9c3d4969

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

Response

Array of leaderboards.

idstring

UUID. Use as leaderboardId in statistics and enrollment calls.

brandIdstring uuid
namestring

Display name shown in the widget.

descriptionstring nullable

Optional longer description.

type'leaderboard' | 'tournament'

leaderboard (auto-enrolled, rank by score) or tournament (opt-in, may have entry cost).

status'draft' | 'active' | 'rewarding' | 'archived'

draft not visible; active running; rewarding period ended, prizes distributing (typically resolves within 5 to 20 minutes); archived terminal state.

objectivesActivatedboolean

true when the leaderboard score is driven by in-app objectives.

startDatestring date-time

When the current period started.

endDatestring date-time

When the current period ends.

isRepeatableboolean

Whether the leaderboard resets and restarts automatically.

resetEveryHoursinteger nullable

Reset interval in hours (e.g. 168 = weekly). null if not repeatable.

objectivesstring[]

Objective IDs that drive the leaderboard score. Empty array when objectivesActivated is false.

participationCostCurrencyIdstring uuid nullable

UUID of the currency required to enter (tournaments only). null if free.

participationCostAmountinteger nullable

Amount of that currency required to enter (tournaments only). null if free.

createdAtstring date-time
updatedAtstring date-time