v20

OpenAPI 3.1.0raw.githubusercontent.com2026-08-011984401.2 MB
League: Rules & Config

Get league settings

Returns full league settings for admin tooling. Requires a personal or developer API key whose owner is currently a league ADMIN of the league in the path, with leagues.settings_read:read access on the key. These admin reads no longer require a paid developer plan; they stay authority-gated (current league ADMIN) and rate-limited by the league owner's plan. League API WRITE routes still require the leagueOperatorApi feature (api_pro or higher) on the league owner's plan.

post/leagues/{identifier}/settings

Path parameters

identifierstring required

League slug or Convex league ID.

League slug or Convex league ID.

Response

League settings.

leagueobject required
timestampstring required