Skip to main content
GET
Get division rewards

Authorizations

Authorization
string
header
required

Bearer token issued by Softmax

Path Parameters

division_id
string
required

Division whose rewards should be returned.

Pattern: ^div_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Response

Successful Response

Reward schedule, league pool, and player totals for one division.

division_id
string
required

Division whose reward schedule and totals are returned.

enabled
boolean
required

Whether scheduled rewards are enabled for this division.

award_time
string | null
required

League-local daily award time when rewards are enabled.

Pattern: ^([01]\d|2[0-3]):[0-5]\d$
time_zone
string
required

IANA time zone used to schedule daily awards.

credits_by_rank
number[]
required

Credit amounts by leaderboard rank, starting with first place.

next_award_at
string<date-time> | null
required

Next scheduled award time, or null when rewards are disabled.

league_pool_credits
number
required

Credits currently available in the league-wide reward pool.

entries
PlayerRewardsPublic · object[]
required

Players that have received rewards in this division.