{"info":{"title":"tournaments basic","version":"1.0","contact":{"name":"Beamable Support","url":"https://api.beamable.com","email":"support@beamable.com"}},"servers":[{"url":"https://api.beamable.com"}],"paths":{"/basic/tournaments/search/groups":{"post":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetStatusForGroupsResponse"}}}},"400":{"description":"Bad Request"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetStatusForGroupsRequest"}}}},"security":[{}]},"parameters":[{"name":"X-BEAM-SCOPE","in":"header","schema":{"type":"string"},"description":"Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.","required":true},{"name":"X-BEAM-GAMERTAG","in":"header","schema":{"type":"string"},"description":"Override the Gamer Tag of the player. This is generally inferred by the auth token.","required":false}]},"/basic/tournaments/":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TournamentQueryResponse"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"isRunning","in":"query","schema":{"type":"boolean"},"required":false},{"name":"contentId","in":"query","schema":{"type":"string"},"required":false},{"name":"cycle","in":"query","schema":{"type":"integer","format":"int32"},"required":false}],"security":[{}]},"post":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlayerStatus"}}}},"400":{"description":"Bad Request"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JoinRequest"}}}},"security":[{"user":[]},{"server":[]}]},"parameters":[{"name":"X-BEAM-SCOPE","in":"header","schema":{"type":"string"},"description":"Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.","required":true},{"name":"X-BEAM-GAMERTAG","in":"header","schema":{"type":"string"},"description":"Override the Gamer Tag of the player. This is generally inferred by the auth token.","required":false}]},"/basic/tournaments/me/group":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetGroupStatusResponse"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"contentId","in":"query","schema":{"type":"string"},"required":false}],"security":[{"user":[]},{"server":[]}]},"parameters":[{"name":"X-BEAM-SCOPE","in":"header","schema":{"type":"string"},"description":"Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.","required":true},{"name":"X-BEAM-GAMERTAG","in":"header","schema":{"type":"string"},"description":"Override the Gamer Tag of the player. This is generally inferred by the auth token.","required":false}]},"/basic/tournaments/rewards":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RewardsResponse"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"tournamentId","in":"query","schema":{"type":"string"},"required":false},{"name":"contentId","in":"query","schema":{"type":"string"},"required":false}],"security":[{"user":[]},{"server":[]}]},"post":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RewardsResponse"}}}},"400":{"description":"Bad Request"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RewardsRequest"}}}},"security":[{"user":[]},{"server":[]}]},"parameters":[{"name":"X-BEAM-SCOPE","in":"header","schema":{"type":"string"},"description":"Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.","required":true},{"name":"X-BEAM-GAMERTAG","in":"header","schema":{"type":"string"},"description":"Override the Gamer Tag of the player. This is generally inferred by the auth token.","required":false}]},"/basic/tournaments/global":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetStandingsResponse"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"tournamentId","in":"query","schema":{"type":"string"},"required":true},{"name":"max","in":"query","schema":{"type":"integer","format":"int32"},"required":false},{"name":"focus","in":"query","schema":{"type":"integer","format":"int64"},"required":false},{"name":"cycle","in":"query","schema":{"type":"integer","format":"int32"},"required":false},{"name":"from","in":"query","schema":{"type":"integer","format":"int32"},"required":false},{"name":"contentId","in":"query","schema":{"type":"string"},"required":false}],"security":[{"user":[]},{"server":[]}]},"parameters":[{"name":"X-BEAM-SCOPE","in":"header","schema":{"type":"string"},"description":"Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.","required":true},{"name":"X-BEAM-GAMERTAG","in":"header","schema":{"type":"string"},"description":"Override the Gamer Tag of the player. This is generally inferred by the auth token.","required":false}]},"/basic/tournaments/standings/group":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetStandingsResponse"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"tournamentId","in":"query","schema":{"type":"string"},"required":true},{"name":"max","in":"query","schema":{"type":"integer","format":"int32"},"required":false},{"name":"focus","in":"query","schema":{"type":"integer","format":"int64"},"required":false},{"name":"cycle","in":"query","schema":{"type":"integer","format":"int32"},"required":false},{"name":"from","in":"query","schema":{"type":"integer","format":"int32"},"required":false},{"name":"contentId","in":"query","schema":{"type":"string"},"required":false}],"security":[{"user":[]},{"server":[]}]},"parameters":[{"name":"X-BEAM-SCOPE","in":"header","schema":{"type":"string"},"description":"Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.","required":true},{"name":"X-BEAM-GAMERTAG","in":"header","schema":{"type":"string"},"description":"Override the Gamer Tag of the player. This is generally inferred by the auth token.","required":false}]},"/basic/tournaments/standings":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetStandingsResponse"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"tournamentId","in":"query","schema":{"type":"string"},"required":true},{"name":"max","in":"query","schema":{"type":"integer","format":"int32"},"required":false},{"name":"focus","in":"query","schema":{"type":"integer","format":"int64"},"required":false},{"name":"cycle","in":"query","schema":{"type":"integer","format":"int32"},"required":false},{"name":"from","in":"query","schema":{"type":"integer","format":"int32"},"required":false},{"name":"contentId","in":"query","schema":{"type":"string"},"required":false}],"security":[{"user":[]},{"server":[]}]},"parameters":[{"name":"X-BEAM-SCOPE","in":"header","schema":{"type":"string"},"description":"Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.","required":true},{"name":"X-BEAM-GAMERTAG","in":"header","schema":{"type":"string"},"description":"Override the Gamer Tag of the player. This is generally inferred by the auth token.","required":false}]},"/basic/tournaments/admin/player":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminGetPlayerStatusResponse"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"playerId","in":"query","schema":{"type":"integer","format":"int64"},"required":true},{"name":"tournamentId","in":"query","schema":{"type":"string"},"required":false},{"name":"contentId","in":"query","schema":{"type":"string"},"required":false},{"name":"hasUnclaimedRewards","in":"query","schema":{"type":"boolean"},"required":false}],"security":[{"user":["admin"]},{"server":[]}]},"put":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminPlayerStatus"}}}},"400":{"description":"Bad Request"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePlayerStatusRequest"}}}},"security":[{"user":["admin"]},{"server":[]}]},"parameters":[{"name":"X-BEAM-SCOPE","in":"header","schema":{"type":"string"},"description":"Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.","required":true},{"name":"X-BEAM-GAMERTAG","in":"header","schema":{"type":"string"},"description":"Override the Gamer Tag of the player. This is generally inferred by the auth token.","required":false}]},"/basic/tournaments/me":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPlayerStatusResponse"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"tournamentId","in":"query","schema":{"type":"string"},"required":false},{"name":"contentId","in":"query","schema":{"type":"string"},"required":false},{"name":"hasUnclaimedRewards","in":"query","schema":{"type":"boolean"},"required":false}],"security":[{"user":[]},{"server":[]}]},"parameters":[{"name":"X-BEAM-SCOPE","in":"header","schema":{"type":"string"},"description":"Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.","required":true},{"name":"X-BEAM-GAMERTAG","in":"header","schema":{"type":"string"},"description":"Override the Gamer Tag of the player. This is generally inferred by the auth token.","required":false}]},"/basic/tournaments/champions":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetChampionsResponse"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"tournamentId","in":"query","schema":{"type":"string"},"required":true},{"name":"cycles","in":"query","schema":{"type":"integer","format":"int32"},"required":true},{"name":"contentId","in":"query","schema":{"type":"string"},"required":false}],"security":[{"user":[]},{"server":[]}]},"parameters":[{"name":"X-BEAM-SCOPE","in":"header","schema":{"type":"string"},"description":"Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.","required":true},{"name":"X-BEAM-GAMERTAG","in":"header","schema":{"type":"string"},"description":"Override the Gamer Tag of the player. This is generally inferred by the auth token.","required":false}]},"/basic/tournaments/score":{"post":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmptyResponse"}}}},"400":{"description":"Bad Request"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScoreRequest"}}}},"security":[{}]},"parameters":[{"name":"X-BEAM-SCOPE","in":"header","schema":{"type":"string"},"description":"Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.","required":true},{"name":"X-BEAM-GAMERTAG","in":"header","schema":{"type":"string"},"description":"Override the Gamer Tag of the player. This is generally inferred by the auth token.","required":false}]},"/basic/tournaments/groups":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetGroupsResponse"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"tournamentId","in":"query","schema":{"type":"string"},"required":true},{"name":"max","in":"query","schema":{"type":"integer","format":"int32"},"required":false},{"name":"focus","in":"query","schema":{"type":"integer","format":"int64"},"required":false},{"name":"cycle","in":"query","schema":{"type":"integer","format":"int32"},"required":false},{"name":"from","in":"query","schema":{"type":"integer","format":"int32"},"required":false},{"name":"contentId","in":"query","schema":{"type":"string"},"required":false}],"security":[{"user":[]},{"server":[]}]},"parameters":[{"name":"X-BEAM-SCOPE","in":"header","schema":{"type":"string"},"description":"Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.","required":true},{"name":"X-BEAM-GAMERTAG","in":"header","schema":{"type":"string"},"description":"Override the Gamer Tag of the player. This is generally inferred by the auth token.","required":false}]}},"components":{"schemas":{"RewardsResponse":{"properties":{"rewardCurrencies":{"type":"array","items":{"$ref":"#/components/schemas/TournamentCurrencyReward"}}},"additionalProperties":false,"title":"Rewards Response","type":"object","required":["rewardCurrencies"]},"GroupStatus":{"type":"object","additionalProperties":false,"properties":{"lastUpdateCycle":{"type":"integer","format":"int32"},"tournamentId":{"type":"string"},"stage":{"type":"integer","format":"int32"},"tier":{"type":"integer","format":"int32"},"groupId":{"type":"integer","format":"int64"},"completed":{"type":"array","items":{"$ref":"#/components/schemas/CompletedStatus"}},"contentId":{"type":"string"}},"required":["contentId","tournamentId","groupId","tier","stage","lastUpdateCycle"]},"GetPlayerStatusRequest":{"properties":{"tournamentId":{"type":"string"},"contentId":{"type":"string"},"hasUnclaimedRewards":{"type":"boolean"}},"additionalProperties":false,"title":"Get Player Status Request","type":"object"},"GetPlayerStatusResponse":{"properties":{"statuses":{"type":"array","items":{"$ref":"#/components/schemas/PlayerStatus"}}},"additionalProperties":false,"title":"Get Player Status Response","type":"object","required":["statuses"]},"RewardsRequest":{"properties":{"tournamentId":{"type":"string"},"contentId":{"type":"string"}},"additionalProperties":false,"title":"Rewards Request","type":"object"},"ScoreRequest":{"properties":{"tournamentId":{"type":"string"},"stats":{"type":"object","additionalProperties":{"type":"string"}},"score":{"type":"number","format":"double"},"playerId":{"type":"integer","format":"int64"},"contentId":{"type":"string"},"increment":{"type":"boolean"}},"additionalProperties":false,"title":"Score Request","type":"object","required":["playerId","tournamentId","score"]},"AdminGetPlayerStatusRequest":{"properties":{"playerId":{"type":"integer","format":"int64"},"tournamentId":{"type":"string"},"contentId":{"type":"string"},"hasUnclaimedRewards":{"type":"boolean"}},"additionalProperties":false,"title":"Admin Get Player Status Request","type":"object","required":["playerId"]},"GetGroupStatusRequest":{"properties":{"contentId":{"type":"string"}},"additionalProperties":false,"title":"Get Group Status Request","type":"object"},"GetChampionsResponse":{"properties":{"entries":{"type":"array","items":{"$ref":"#/components/schemas/ChampionScore"}}},"additionalProperties":false,"title":"Get Champions Response","type":"object","required":["entries"]},"TournamentClientView":{"type":"object","additionalProperties":false,"properties":{"tournamentId":{"type":"string"},"startTimeUtc":{"type":"string"},"secondsRemaining":{"type":"integer","format":"int64"},"cycle":{"type":"integer","format":"int32"},"endTimeUtc":{"type":"string"},"contentId":{"type":"string"}},"required":["tournamentId","secondsRemaining","contentId","cycle","startTimeUtc","endTimeUtc"]},"GetStatusForGroupsResponse":{"properties":{"statuses":{"type":"array","items":{"$ref":"#/components/schemas/GroupStatus"}},"contentId":{"type":"string"}},"additionalProperties":false,"title":"Get Status For Groups Response","type":"object","required":["statuses","contentId"]},"GetStandingsRequest":{"properties":{"tournamentId":{"type":"string"},"max":{"type":"integer","format":"int32"},"focus":{"type":"integer","format":"int64"},"cycle":{"type":"integer","format":"int32"},"from":{"type":"integer","format":"int32"},"contentId":{"type":"string"}},"additionalProperties":false,"title":"Get Standings Request","type":"object","required":["tournamentId"]},"TournamentEntry":{"type":"object","additionalProperties":false,"properties":{"stage":{"type":"integer","format":"int32"},"tier":{"type":"integer","format":"int32"},"previousStageChange":{"type":"integer","format":"int32"},"rank":{"type":"integer","format":"int64"},"score":{"type":"number","format":"double"},"currencyRewards":{"type":"array","items":{"$ref":"#/components/schemas/TournamentCurrencyReward"}},"nextStageChange":{"type":"integer","format":"int32"},"playerId":{"type":"integer","format":"int64"},"stageChange":{"type":"integer","format":"int32"}},"required":["playerId","rank","score","tier","stage","stageChange","currencyRewards"]},"PlayerStatusUpdate":{"type":"object","additionalProperties":false,"properties":{"tier":{"type":"integer","format":"int32"},"stage":{"type":"integer","format":"int32"},"score":{"type":"number","format":"double"}}},"TournamentQueryResponse":{"properties":{"tournaments":{"type":"array","items":{"$ref":"#/components/schemas/TournamentClientView"}}},"additionalProperties":false,"title":"Tournament Query Response","type":"object","required":["tournaments"]},"PlayerStatus":{"type":"object","additionalProperties":false,"properties":{"lastUpdateCycle":{"type":"integer","format":"int32"},"tournamentId":{"type":"string"},"stage":{"type":"integer","format":"int32"},"unclaimedRewards":{"type":"array","items":{"$ref":"#/components/schemas/TournamentCurrencyReward"}},"tier":{"type":"integer","format":"int32"},"groupId":{"type":"integer","format":"int64"},"playerId":{"type":"integer","format":"int64"},"contentId":{"type":"string"}},"required":["contentId","tournamentId","playerId","tier","stage","lastUpdateCycle","unclaimedRewards"]},"CompletedStatus":{"type":"object","additionalProperties":false,"properties":{"cycle":{"type":"integer","format":"int32"},"tier":{"type":"integer","format":"int32"},"stage":{"type":"integer","format":"int32"},"delta":{"type":"integer","format":"int32"}},"required":["cycle","tier","stage","delta"]},"GetStandingsResponse":{"properties":{"entries":{"type":"array","items":{"$ref":"#/components/schemas/TournamentEntry"}},"me":{"$ref":"#/components/schemas/TournamentEntry"}},"additionalProperties":false,"title":"Get Standings Response","type":"object","required":["entries"]},"TournamentQueryRequest":{"properties":{"isRunning":{"type":"boolean"},"contentId":{"type":"string"},"cycle":{"type":"integer","format":"int32"}},"additionalProperties":false,"title":"Tournament Query Request","type":"object"},"TournamentCurrencyReward":{"type":"object","additionalProperties":false,"properties":{"symbol":{"type":"string"},"amount":{"type":"integer","format":"int64"}},"required":["symbol","amount"]},"JoinRequest":{"properties":{"tournamentId":{"type":"string"},"contentId":{"type":"string"}},"additionalProperties":false,"title":"Join Request","type":"object","required":["tournamentId"]},"GetGroupsResponse":{"properties":{"entries":{"type":"array","items":{"$ref":"#/components/schemas/TournamentGroupEntry"}},"focus":{"$ref":"#/components/schemas/TournamentGroupEntry"}},"additionalProperties":false,"title":"Get Groups Response","type":"object","required":["entries"]},"TournamentGroupEntry":{"type":"object","additionalProperties":false,"properties":{"rank":{"type":"integer","format":"int64"},"score":{"type":"number","format":"double"},"currencyRewards":{"type":"array","items":{"$ref":"#/components/schemas/TournamentCurrencyReward"}},"groupId":{"type":"integer","format":"int64"},"stageChange":{"type":"integer","format":"int32"}},"required":["groupId","rank","score","stageChange","currencyRewards"]},"GetStatusForGroupsRequest":{"properties":{"groupIds":{"type":"array","items":{"type":"integer","format":"int64"}},"contentId":{"type":"string"}},"additionalProperties":false,"title":"Get Status For Groups Request","type":"object","required":["groupIds","contentId"]},"EmptyResponse":{"properties":{"result":{"type":"string"}},"additionalProperties":false,"title":"Empty Response","type":"object","required":["result"]},"GetGroupStatusResponse":{"properties":{"statuses":{"type":"array","items":{"$ref":"#/components/schemas/GroupStatus"}}},"additionalProperties":false,"title":"Get Group Status Response","type":"object","required":["statuses"]},"GetGroupsRequest":{"properties":{"tournamentId":{"type":"string"},"max":{"type":"integer","format":"int32"},"focus":{"type":"integer","format":"int64"},"cycle":{"type":"integer","format":"int32"},"from":{"type":"integer","format":"int32"},"contentId":{"type":"string"}},"additionalProperties":false,"title":"Get Groups Request","type":"object","required":["tournamentId"]},"AdminPlayerStatus":{"type":"object","additionalProperties":false,"properties":{"tournamentId":{"type":"string"},"stage":{"type":"integer","format":"int32"},"unclaimedRewards":{"type":"array","items":{"$ref":"#/components/schemas/TournamentCurrencyReward"}},"tier":{"type":"integer","format":"int32"},"rank":{"type":"integer","format":"int32"},"score":{"type":"number","format":"double"},"playerId":{"type":"integer","format":"int64"},"contentId":{"type":"string"},"nextCycleStartMs":{"type":"integer","format":"int64"}},"required":["contentId","tournamentId","playerId","tier","stage","rank","score","unclaimedRewards","nextCycleStartMs"]},"UpdatePlayerStatusRequest":{"properties":{"playerId":{"type":"integer","format":"int64"},"tournamentId":{"type":"string"},"update":{"$ref":"#/components/schemas/PlayerStatusUpdate"}},"additionalProperties":false,"title":"Update Player Status Request","type":"object","required":["playerId","tournamentId","update"]},"ChampionScore":{"type":"object","additionalProperties":false,"properties":{"endTimeMs":{"type":"integer","format":"int64"},"startTimeMs":{"type":"integer","format":"int64"},"score":{"type":"number","format":"double"},"cycle":{"type":"integer","format":"int32"},"playerId":{"type":"integer","format":"int64"}},"required":["playerId","score","cycle","startTimeMs","endTimeMs"]},"GetChampionsRequest":{"properties":{"tournamentId":{"type":"string"},"cycles":{"type":"integer","format":"int32"},"contentId":{"type":"string"}},"additionalProperties":false,"title":"Get Champions Request","type":"object","required":["tournamentId","cycles"]},"AdminGetPlayerStatusResponse":{"properties":{"statuses":{"type":"array","items":{"$ref":"#/components/schemas/AdminPlayerStatus"}}},"additionalProperties":false,"title":"Admin Get Player Status Response","type":"object","required":["statuses"]}},"securitySchemes":{"server":{"type":"apiKey","name":"X-DE-SIGNATURE","in":"header","description":"Signed Request authentication using project secret key."},"user":{"type":"http","description":"Bearer authentication with a player access token in the Authorization header.","scheme":"bearer","bearerFormat":"Bearer <Access Token>"}}},"security":[],"externalDocs":{"description":"Beamable Documentation","url":"https://docs.beamable.com"},"openapi":"3.0.2"}