Skip to main content
GET
Get campaign board

Authorizations

Authorization
string
header
required

Bearer token issued by Softmax

Path Parameters

league_id
string
required

League whose campaign board should be returned.

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

league_id
string
required

League whose campaign board is returned.

enabled
boolean
required

Whether campaign rounds are enabled.

config
Config · object
required

Public campaign geometry and round settings.

players
Players · object[]
required

Visible campaign players and board symbols.

viewer_player_ids
string[]
required

Campaign players owned by the caller.

map_refs
string[]
required

Coworld variant ID for each bounding-grid position.

modes
string[]
required

Match mode for each bounding-grid position.

map_seeds
(integer | null)[]
required

Generated-map seed for each bounding-grid position.

map_sizes
(string | null)[]
required

Generated-map size for each bounding-grid position.

champions
(integer | null)[]
required

Distinct policy seats for each bounding-grid position.

agents
(integer | null)[]
required

Total agent seats for each bounding-grid position.

preview_urls
(string | null)[]
required

Authored map preview for each bounding-grid position.

round
integer
required

Number of completed campaign rounds.

frames
Frames · object[]
required

Retained board snapshots ordered by round.

events
Events · object[]
required

Retained campaign events ordered by time.

blob_ids
integer[] | null

Contiguous territory ID for each bounding-grid position.

pending_round
Pending Round · object | null

Visible state for an in-flight campaign round.

color_prefs
Color Prefs · object

Preferred board-palette slot keyed by player ID.

perks
Perks · object

Equipped Coworld perk IDs keyed by player ID.