Skip to main content
GET
Get League

Authorizations

Authorization
string
header
required

Bearer token issued by Softmax

Path Parameters

league_id
string
required
Pattern: ^league_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Response

Successful Response

name
string
required
commissioner_key
string
required
id
string
required
game
GamePublic · object
required
mod
ModPublic · object | null
required
created_at
string<date-time>
required
description
string | null
commissioner_config
Commissioner Config · object | null
commissioner_migration_version
string | null
rounds_paused_at
string<date-time> | null
settings
Settings · object | null
filler_policy_version_ids
string<uuid>[] | null
rules
Rules · object | null
public
boolean
default:false
hidden
boolean
default:false
is_game_of_week
boolean
default:false
disabled_at
string<date-time> | null
notes
string | null