Challengermode
Home
Dashboard
Game Integration API
Client API
Auth API
Embeds

Client API

Query

broadcast

Enterprise
Get a Broadcast by it's ID.

Arguments

Name
Description
id: UUID!
The ID of the broadcast.

match

Get a match by ID. A match can be part of a larger competition type such as a tournament or matchmaking queue, or created as a custom game.

Arguments

Name
Description
matchId: UUID!

ownCupEligibility

Enterprise
Description of whether the user is eligible to join the competition.

Arguments

Name
Description

cup

Enterprise
Get a cup by its ID.

Arguments

Name
Description
id: UUID!

searchCups

Enterprise
Search for cups.

Arguments

Name
Description
limit: Int
skip: Int
descending: Boolean

cupsForGame

Enterprise
Deprecated
DeprecatedUse 'searchCups' instead.
Search for cups based on search input critera.

Response

Returns a CupsForGameConnection
@authorize(policy: BOT|PAT)@listSize(assumedSize: 200, slicingArguments: [first], slicingArgumentDefaultValue: 10, sizedFields: [edges, nodes], requireOneSlicingArgument: false)@cost(weight: 10)@deprecated(reason: Use 'searchCups' instead.)

Arguments

Name
Description
input: CupsForGameInput!
after: String
Returns the elements in the list that come after the specified cursor.
first: Int
Returns the first _n_ elements from the list.

gameTitle

Get a game title.

Arguments

Name
Description
Identifier for the game.

leaderboard

Core
Get leaderboard by ID.

Arguments

Name
Description
id: UUID!

matchmakingQueuesForGame

Core
Find match making queues in a specific game title.

Arguments

Name
Description
gameSlug: String!

matchmakingQueue

Core
Find matchmaking queue by ID.

Arguments

Name
Description
queueId: UUID!

me

Get the authenticated user's profile. This can be used as a starting point to find the activities (e.g. tournaments) the user is participating in.

space

Get a Space by its slug.

Arguments

Name
Description
Identifier for the Space.
slug: String
DeprecatedUse space identifier instead.
Case-insensitive slug for the Space, i.e ~/s/{slug}

userActiveSubscriptionsByPerk

Get the active subscriptions that grant a specific perk to a user.

Arguments

Name
Description
userId: UUID!
The user ID to check active subscriptions for.
catalogId: UUID!
The subscription catalog ID for context.
perkId: UUID!
The subscription perk ID to check for.

team

Get a team by ID.

Arguments

Name
Description
id: UUID!
The public ID of the team, (~/teams/<team-id>).

laddersForGame

Deprecated
DeprecatedUse leaderboard queries instead.
Find ladders in a specific game title.

Response

Returns a [Ladder!]!
@authorize(policy: BOT|PAT)@cost(weight: 10)@deprecated(reason: Use leaderboard queries instead.)

Arguments

Name
Description
input: LaddersForGameInput!

laddersForSpace

Deprecated
DeprecatedUse leaderboard queries instead.
Find ladders in a specific Space.

Response

Returns a [Ladder!]!
@authorize(policy: BOT|PAT)@cost(weight: 10)@deprecated(reason: Use leaderboard queries instead.)

Arguments

Name
Description
input: LaddersForSpaceInput!

ladder

Deprecated
DeprecatedUse leaderboard queries instead.
Get ladder by ID.

Response

Returns a Ladder!
@authorize(policy: BOT|PAT)@cost(weight: 10)@deprecated(reason: Use leaderboard queries instead.)

Arguments

Name
Description
ladderId: UUID!

ownTournamentEligibility

Summarizes whether a user meets the requirements to participate in the tournament.

Arguments

Name
Description

tournamentsForGame

Find tournaments in a specific game title.

Arguments

Name
Description

tournamentsForSpace

Find tournaments in a specific Space.

Arguments

Name
Description

tournament

Get tournament by ID.

Arguments

Name
Description
tournamentId: UUID!

tournamentLineup

Get tournament lineup by ID.

Arguments

Name
Description
id: UUID!

matchSeries

Get a match series by ID.

Arguments

Name
Description
matchSeriesId: UUID!

user

Get a user by their user ID, as found on ~/users/<user-id>.

Arguments

Name
Description
userId: UUID!