Get started

Setup & Identity

Configuration fields that control how your ladder looks and who can find and join it.

Identity & branding

How your ladder appears on its public page and in the organization workspace.

Name

Field: name — string (max 200)

The ladder's display name. Shown on the public page header and in lists.

Slug

Field: slug — string (max 100)

URL slug used in the public route /ladders/{slug}. Globally unique. Auto-generated from the name on create; editable in Settings while the ladder is PENDING.

Description

Field: description — text

Short blurb shown above the standings. Plain text; rules go in the dedicated rules section.

Field: avatarUrl — image URL

Square logo shown in the ladder header. Recommended 256×256 or larger.

Field: bannerUrl — image URL

Wide hero image rendered behind the title on the public page.

Accent color

Field: accentColor — hex (#RRGGBB)

Brand accent. Used for the public-page accent strip and bracket highlights.

Custom title

Field: customTitle — string (max 200)

Override the page H1 with a custom string (e.g. "Season 4 Championship Ladder"). Falls back to Name when empty.

Access & visibility

Who can find the ladder and who can join it.

Access mode

Field: accessMode — PUBLIC | INVITE_ONLY | HIDDEN

  • PUBLIC: anyone with the ladder link can join.
  • INVITE_ONLY: only invited teams on the allowlist can join.
  • HIDDEN: invite-only and omitted from organization public listings.

Visible

Field: isVisible — boolean

Master toggle for whether the ladder appears on the public organization page. Defaults to true. When false, the ladder still works for allowed teams through its direct URL.

Region

Field: region — string (max 10)

NA / EU / APAC / SA / GLOBAL, etc. Used as competition metadata; not enforced, so teams from other regions can still join unless your rules say otherwise.

Platforms

Field: platforms — string[]

Allowed platforms (Xbox / PSN / PC / etc.). Players need at least one matching platform linked to their profile to register.

Allowed input

Field: allowedInput — CONTROLLER | MOUSE_AND_KEYBOARD | ANY | PLAYER_CHOICE

Input device restriction. PLAYER_CHOICE lets each player declare their own; ANY waives the check entirely.