0% found this document useful (0 votes)
18 views54 pages

Query and Mutations API

The document outlines the Query and Mutations API, detailing various queries and mutations available for managing entities such as players, teams, tournaments, and content catalog items. It includes specifications for retrieving and manipulating data, including input types and expected arguments. The document serves as a comprehensive reference for developers working with the API to perform operations on gaming-related data.

Uploaded by

adrie0npilkarz
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as TXT, PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
18 views54 pages

Query and Mutations API

The document outlines the Query and Mutations API, detailing various queries and mutations available for managing entities such as players, teams, tournaments, and content catalog items. It includes specifications for retrieving and manipulating data, including input types and expected arguments. The document serves as a comprehensive reference for developers working with the API to perform operations on gaming-related data.

Uploaded by

adrie0npilkarz
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as TXT, PDF, TXT or read online on Scribd

Query and Mutations API

Table of Contents
Queries
allSeries
dataProviders
gameIdByExternalId
organization
organizations
player
playerIdByExternalId
playerRole
playerRoles
players
series
seriesByExternalSeries
seriesFormats
seriesIdByExternalId
team
teamIdByExternalId
teams
title
titles
tournament
tournamentIdByExternalId
tournaments
contentCatalogEntities
contentCatalogEntity
contentCatalogEntityIdByExternalId
contentCatalogVersion
contentCatalogVersionIdByExternalId
contentCatalogVersions
Mutations
createPlayer
createSeries
createTeam
createTournament
deletePlayer
deleteSeries
deleteTeam
deleteTournament
updatePlayer
updateSeries
updateTeam
updateTournament
createContentCatalogItem
createContentCatalogVersion
deleteContentCatalogEntity
deleteContentCatalogVersion
updateContentCatalogItem
updateContentCatalogVersion
Objects
ContentCatalogCharacter
ContentCatalogEntityConnection
ContentCatalogEntityEdge
ContentCatalogItem
ContentCatalogVersion
ContentCatalogVersionConnection
ContentCatalogVersionEdge
CreateContentCatalogCharacterPayload
CreateContentCatalogItemPayload
CreateContentCatalogVersionPayload
CreatePlayerPayload
CreatePlayerRolePayload
CreateSeriesPayload
CreateTeamPayload
CreateTournamentPayload
DataProvider
DeleteContentCatalogEntityPayload
DeleteContentCatalogVersionPayload
DeletePlayerPayload
DeletePlayerRolePayload
DeleteSeriesPayload
DeleteTeamPayload
DeleteTournamentPayload
ExternalEntity
ExternalLink
Money
Nationality
Organization
OrganizationConnection
OrganizationEdge
OrganizationRelation
PageInfo
Player
PlayerConnection
PlayerEdge
PlayerRole
ProductServiceLevel
Series
SeriesConnection
SeriesEdge
SeriesFormat
Team
TeamConnection
TeamEdge
TeamParticipant
TeamRelation
Title
Tournament
TournamentConnection
TournamentEdge
UpdateContentCatalogCharacterPayload
UpdateContentCatalogItemPayload
UpdateContentCatalogVersionPayload
UpdatePlayerPayload
UpdatePlayerRolePayload
UpdateSeriesPayload
UpdateTeamPayload
UpdateTournamentPayload
VideoStream
Inputs
BooleanFilter
ContentCatalogEntityFilter
ContentCatalogEntityTitleFilter
ContentCatalogEntityTypeFilter
ContentCatalogVersionFilter
ContentCatalogVersionOrder
ContentCatalogVersionTitleFilter
CreateContentCatalogCharacterInput
CreateContentCatalogItemInput
CreateContentCatalogVersionInput
CreatePlayerInput
CreatePlayerPlayerRoleInput
CreatePlayerRoleInput
CreatePlayerRoleTitleInput
CreatePlayerTeamInput
CreatePlayerTitleInput
CreateSeriesFormatInput
CreateSeriesInput
CreateSeriesParticipatingPlayersInput
CreateSeriesTeamInput
CreateSeriesTitleInput
CreateSeriesTournamentInput
CreateTeamInput
CreateTeamTitleInput
CreateTournamentInput
CreateTournamentParentInput
CreateTournamentTeamInput
CreateTournamentTitleInput
DateInput
DateTimeFilter
DeletePlayerInput
DeletePlayerRoleInput
DeleteSeriesInput
DeleteTeamInput
DeleteTournamentInput
ExternalEntityInput
ExternalLinkInput
GameFilter
IdFilter
IntFilter
MapFilter
MoneyInput
NationalityFilter
NullableDateFilter
NullableIdFilter
OrganizationFilter
PlayerFilter
PlayerPlayerRoleFilter
PlayerRoleFilter
PlayerRoleTitleFilter
ProductServiceLevelFilter
SeriesFilter
SeriesLiveFilter
SeriesPlayerFilter
SeriesTournamentFilter
SeriesTournamentTitleFilter
StringFilter
TeamFilter
TitleFilter
TournamentFilter
TournamentTitleFilter
UpdateContentCatalogCharacterInput
UpdateContentCatalogItemInput
UpdateContentCatalogVersionInput
UpdateContentCatalogVersionOwnerInput
UpdatePlayerInput
UpdatePlayerPlayerRoleInput
UpdatePlayerRoleInput
UpdatePlayerRoleTitleInput
UpdatePlayerTeamInput
UpdatePlayerTitleInput
UpdateSeriesFormatInput
UpdateSeriesInput
UpdateSeriesParticipatingPlayersInput
UpdateSeriesTeamInput
UpdateSeriesTitleInput
UpdateSeriesTournamentInput
UpdateTeamInput
UpdateTeamTitleInput
UpdateTournamentInput
UpdateTournamentParentInput
UpdateTournamentTeamInput
UpdateTournamentTitleInput
Interfaces
ContentCatalogEntity
OrganizationInterface
TeamInterface
Enums
ContentCatalogEntityType
ContentCatalogVersionOrderField
ErrorDetail
ErrorType
OrderDirection
PlayerType
SeriesOrderBy
SeriesType
ServiceLevel
Scalars
Boolean
Cursor
Date
DateTime
Decimal
Float
HexColor
ID
Int
String
Url
Queries
allSeries
Get multiple series by query specifications. Returns SeriesConnection!.

Argument
Type
Description
after
Cursor
Cursor, after which results to query.
before
Cursor
Cursor, before which results to query.
filter
SeriesFilter
Filters for series results.
first
Int
Amount of nodes to return starting from the beginning. Defaults to 10.
last
Int
Amount of nodes to return starting from the end.
orderBy
SeriesOrderBy!
Ordering of resulting series set.
orderDirection
OrderDirection!
Whether to order by ascending or descending direction.
dataProviders
Get supported data providers. Returns [DataProvider!]!.

No arguments.

gameIdByExternalId
Get the GRID Game ID by an external ID. Returns ID.

Argument
Type
Description
dataProviderName
String!
The name of the data provider to look by. An example could be "STEAM"
externalGameId
ID!
The external ID to look for.
organization
Get an organization by ID. Returns Organization.

Argument
Type
Description
id
ID!
The ID of the organization to retrieve.
organizations
Get multiple organizations by query specifications. Returns OrganizationConnection.

Argument
Type
Description
after
Cursor
Cursor, after which results to query.
before
Cursor
Cursor, before which results to query.
filter
OrganizationFilter
Filters for organization results.
first
Int
Amount of nodes to return starting from the beginning. Defaults to 10.
last
Int
Amount of nodes to return starting from the end.
player
Get a player by ID. Returns Player.

Argument
Type
Description
id
ID!
The ID of the player to retrieve.
playerIdByExternalId
Get the GRID Player ID by an external ID. Returns ID.

Argument
Type
Description
dataProviderName
String!
The name of the data provider to look by. An example could be "STEAM"
externalPlayerId
ID!
The external ID to look for.
titleId
ID
The title player belongs to.
playerRole
Get a player role by ID. Returns PlayerRole.

Argument
Type
Description
id
ID!
None
playerRoles
Get multiple player roles by query specifications. Returns [PlayerRole!]!.

Argument
Type
Description
filter
PlayerRoleFilter
None
players
Get multiple players by query specifications. Returns PlayerConnection.

Argument
Type
Description
after
Cursor
Cursor, after which results to query.
before
Cursor
Cursor, before which results to query.
filter
PlayerFilter
Filters for player results.
first
Int
Amount of nodes to return starting from the beginning. Defaults to 10.
last
Int
Amount of nodes to return starting from the end.
series
Get a series by ID. Returns Series.

Argument
Type
Description
id
ID!
The ID of the series to retrieve.
seriesByExternalSeries
@deprecated(reason: 'Use seriesIdByExternalId instead') Get a series by its
external ID. Returns Series.

Argument
Type
Description
dataProviderName
String!
The name of the data provider to look by. An example could be "STEAM"
externalSeriesId
String!
The external ID to look for.
seriesFormats
Get supported series formats. Returns [SeriesFormat!]!.

No arguments.

seriesIdByExternalId
Get the GRID Series ID by an external ID. Returns ID.

Argument
Type
Description
dataProviderName
String!
The name of the data provider to look by. An example could be "STEAM"
externalSeriesId
ID!
The external ID to look for.
team
Get a team by ID. Returns Team.

Argument
Type
Description
id
ID!
The ID of the team to retrieve.
teamIdByExternalId
Get the GRID Team ID by an external ID. Returns ID.

Argument
Type
Description
dataProviderName
String!
The name of the data provider to look by. An example could be "STEAM"
externalTeamId
ID!
The external ID to look for.
titleId
ID!
The title in which the team participates.
teams
Get multiple teams by query specifications. Returns TeamConnection!.

Argument
Type
Description
after
Cursor
Cursor, after which results to query.
before
Cursor
Cursor, before which results to query.
filter
TeamFilter
Filters for team results.
first
Int
Amount of nodes to return starting from the beginning. Defaults to 10.
last
Int
Amount of nodes to return starting from the end.
title
Get a title by ID. Returns Title.

Argument
Type
Description
id
ID!
The ID of the title to retrieve.
titles
Get all titles. Returns [Title!]!.

Argument
Type
Description
filter
TitleFilter
Filters for titles results.
tournament
Get a tournament by ID. Returns Tournament.

Argument
Type
Description
id
ID!
The ID of the tournament to retrieve.
tournamentIdByExternalId
Get the GRID Tournament ID by an external ID. Returns ID.
Argument
Type
Description
dataProviderName
String!
The name of the data provider to look by. An example could be "STEAM"
externalTournamentId
ID!
The external ID to look for.
tournaments
Get multiple tournaments by query specifications. Returns TournamentConnection!.

Argument
Type
Description
after
Cursor
Cursor, after which results to query.
before
Cursor
Cursor, before which results to query.
filter
TournamentFilter
Filters for tournament results.
first
Int
Amount of nodes to return starting from the beginning. Defaults to 10.
last
Int
Amount of nodes to return starting from the end.
contentCatalogEntities
Get multiple content catalog entities by query specification. Returns
ContentCatalogEntityConnection!.

Argument
Type
Description
after
Cursor
Returns the elements in the list that come after the specified cursor.
before
Cursor
Returns the elements in the list that come before the specified cursor.
contentCatalogVersionId
ID
The content catalog version Id to search entities by.If not specified, the latest
version is selected.
filter
ContentCatalogEntityFilter
Filter specifications.
first
Int
Number of nodes to return starting from the beginning. Defaults to 10.
last
Int
Number of nodes to return starting from the end.
contentCatalogEntity
Get a Content Catalog Entity by ID. Returns ContentCatalogEntity.
Argument
Type
Description
contentCatalogVersionId
ID
The content catalog version of the item.If not specified, the query returns the
item definition of the latest version.
id
ID!
The ID of a Content Catalog Entity.
contentCatalogEntityIdByExternalId
Get the GRID Content Catalog Entity ID by an external ID. Returns ID.

Argument
Type
Description
contentCatalogVersionId
ID
The content catalog version of the item.If not specified, the query returns the id
of the latest item definition.
dataProviderName
String!
The name of the data provider to search by. An example could be 'STEAM'.
externalEntityId
ID!
The external ID to search by.
contentCatalogVersion
Get a Content Catalog Version by ID. Returns ContentCatalogVersion.

Argument
Type
Description
id
ID!
The ID of a Content Catalog Version.
contentCatalogVersionIdByExternalId
Get the GRID Content Catalog Version ID by an external ID. Returns ID.

Argument
Type
Description
dataProviderName
String!
The name of the data provider to search by. An example could be "STEAM".
externalEntityId
ID!
The external ID to search by.
contentCatalogVersions
Get multiple content catalog versions by query specification. Returns
ContentCatalogVersionConnection!.

Argument
Type
Description
after
Cursor
Returns the elements in the list that come after the specified cursor.
before
Cursor
Returns the elements in the list that come before the specified cursor.
filter
ContentCatalogVersionFilter
Filter specifications.
first
Int
Number of nodes to return starting from the beginning. Defaults to 10.
last
Int
Number of nodes to return starting from the end.
orderBy
[ContentCatalogVersionOrder!]
Ordering options.
Mutations
createPlayer
Creates a new GRID player. Returns CreatePlayerPayload!.

Argument
Type
Description
createPlayerInput
CreatePlayerInput!
Expects the nickname, the team the player belongs to and the title the player
participates in and optionally the external links associated with the player.
createSeries
Creates a new GRID Series. Returns CreateSeriesPayload!.

Argument
Type
Description
createSeriesInput
CreateSeriesInput!
Expects the title for the series, the tournament where it's being played, the teams
playing it, the start date and time, and the format.
createTeam
Creates a new GRID team. Returns CreateTeamPayload!.

Argument
Type
Description
createTeamInput
CreateTeamInput!
Expects the name, the title the team participates in and optionally the primary
and/or secondary colors, the logo of the team and the external links associated
with the team.
createTournament
Creates a new GRID tournament. Returns CreateTournamentPayload!.

Argument
Type
Description
createTournamentInput
CreateTournamentInput!
Expects the name and short name, and optionally the titles for the tournament, the
teams playing in it, and the logo of the tournament.
deletePlayer
Deletes an existing GRID player. Returns DeletePlayerPayload!.

Argument
Type
Description
deletePlayerInput
DeletePlayerInput!
Expects the ID of an existing player.
deleteSeries
Deletes an existing GRID Series. Returns DeleteSeriesPayload!.

Argument
Type
Description
deleteSeriesInput
DeleteSeriesInput!
Expects the ID of an existing Series.
deleteTeam
Deletes an existing GRID team. Returns DeleteTeamPayload!.

Argument
Type
Description
deleteTeamInput
DeleteTeamInput!
Expects the ID of an existing team.
deleteTournament
Deletes an existing GRID tournament. Returns DeleteTournamentPayload!.

Argument
Type
Description
deleteTournamentInput
DeleteTournamentInput!
Expects the ID of an existing tournament.
updatePlayer
Updates an existing GRID player. Returns UpdatePlayerPayload!.

Argument
Type
Description
updatePlayerInput
UpdatePlayerInput!
Expects the ID of the player, and optionally the nickname, the team the player
belongs to, the title the player participates in and the external links associated
with the player.
updateSeries
Updates an existing GRID Series. Returns UpdateSeriesPayload!.

Argument
Type
Description
updateSeriesInput
UpdateSeriesInput!
Expects the ID, and optionally can receive: the title, the tournament, the teams,
the start date and time, and/or the format.
updateTeam
Updates an existing GRID team. Returns UpdateTeamPayload!.

Argument
Type
Description
updateTeamInput
UpdateTeamInput!
Expects the ID of the team and optionally the name, the title the team participates
in, the primary and the primary and/or secondary colors, the logo of the team and
the external links associated with the team.
updateTournament
Updates an existing GRID tournament. Returns UpdateTournamentPayload!.

Argument
Type
Description
updateTournamentInput
UpdateTournamentInput!
Expects the ID of the tournament, and optionally the name, the short name, the
titles for the tournament, the teams playing in it, and/or the logo of the
tournament.
createContentCatalogItem
Creates a new version for a content catalog item. Returns
CreateContentCatalogItemPayload!.

Argument
Type
Description
createContentCatalogItemInput
CreateContentCatalogItemInput!
None
createContentCatalogVersion
Creates a new content catalog version. Returns CreateContentCatalogVersionPayload!.

Argument
Type
Description
createContentCatalogVersionInput
CreateContentCatalogVersionInput!
None
deleteContentCatalogEntity
Deletes a specific version of a content catalog entity. Returns
DeleteContentCatalogEntityPayload!.

Argument
Type
Description
contentCatalogVersionId
ID!
The version of the content catalog entity to be deleted.
id
ID!
The ID of the entity to be deleted.
deleteContentCatalogVersion
Deletes a specific content catalog version. Returns
DeleteContentCatalogVersionPayload!.

Argument
Type
Description
id
ID!
The ID of the content catalog version to delete.
updateContentCatalogItem
Updates a specific version of a content catalog item. Returns
UpdateContentCatalogItemPayload!.

Argument
Type
Description
updateContentCatalogItemInput
UpdateContentCatalogItemInput!
None
updateContentCatalogVersion
Updates a specific content catalog version Returns
UpdateContentCatalogVersionPayload!.

Argument
Type
Description
updateContentCatalogVersionInput
UpdateContentCatalogVersionInput!
None
Objects
ContentCatalogCharacter
A content catalog character.

Field
Type
Description
contentCatalogVersion
ContentCatalogVersion!
The content catalog version this entity appears in.
externalLinks
[ExternalLink!]!
The content catalog entity version external IDs and providers.
id
ID!
The ID of a content catalog entity.
imageUrl
Url!
The URL to the content catalog entity's image
name
String!
The name of a content catalog entity.
private
Boolean
The visibility of this entity to other users.
ContentCatalogEntityConnection
The result of querying list of content catalog entities, which provides additional
information.

Field
Type
Description
edges
[ContentCatalogEntityEdge!]!
All content catalog entities edges for a query on a given page.
pageInfo
PageInfo!
Information about the current page being pulled with a query.
totalCount
Int!
Total count of content catalog entities matching the filtering in the API.
ContentCatalogEntityEdge
Content catalog entity and cursor information.

Field
Type
Description
cursor
Cursor!
Content catalog entity cursor value for the edge.
node
ContentCatalogEntity!
A content catalog entity.
ContentCatalogItem
A content catalog item.

Field
Type
Description
contentCatalogVersion
ContentCatalogVersion!
The content catalog version this entity appears in.
cost
Float!
The cost of an item. When not set, defaults to 0.
externalLinks
[ExternalLink!]!
The content catalog entity version external IDs and providers.
id
ID!
The ID of the content catalog entity.
imageUrl
Url!
The URL to the content catalog entity's image.
name
String!
The name of the content catalog entity.
private
Boolean
The visibility of this entity to other users.
ContentCatalogVersion
A content catalog version.

Field
Type
Description
externalLinks
[ExternalLink!]!
The content catalog version external IDs and providers.
id
ID!
The unique identifier of the content catalog version.
name
String!
The unique name of the content catalog version. E.g. 7.34.
private
Boolean
The visibility of this version to other users.
publishedOn
DateTime!
The date and time when the content catalog version becomes effective.
title
Title!
The title which the content catalog version belongs to.
ContentCatalogVersionConnection
The result of querying list of content catalog versions, which provides additional
information.

Field
Type
Description
edges
[ContentCatalogVersionEdge!]!
All content catalog version edges for a query on a given page.
pageInfo
PageInfo!
Information about the current page being pulled with a query.
totalCount
Int!
Total count of content catalog versions matching the filtering in the API.
ContentCatalogVersionEdge
Content catalog version and cursor information.

Field
Type
Description
cursor
Cursor!
Content catalog version cursor value for the edge.
node
ContentCatalogVersion!
A content catalog version.
CreateContentCatalogCharacterPayload
The response for the createContentCatalogCharacter mutation.

Field
Type
Description
createdContentCatalogCharacter
ContentCatalogCharacter!
The created content catalog character information.
CreateContentCatalogItemPayload
The response for the createContentCatalogItem mutation.

Field
Type
Description
createdContentCatalogItem
ContentCatalogItem!
The created content catalog version information.
CreateContentCatalogVersionPayload
The response for the createContentCatalogVersion mutation.

Field
Type
Description
createdContentCatalogVersion
ContentCatalogVersion!
The created content catalog version information.
CreatePlayerPayload
The response for the createPlayer mutation.

Field
Type
Description
createdPlayer
Player!
The created player information.
CreatePlayerRolePayload
The response for the createPlayerRole mutation.

Field
Type
Description
createdPlayerRole
PlayerRole!
The created player role information.
CreateSeriesPayload
The response for the createSeries mutation.

Field
Type
Description
createdSeries
Series!
The created series information.
CreateTeamPayload
The response for the createTeam mutation.

Field
Type
Description
createdTeam
Team!
The created team information.
CreateTournamentPayload
The response for the createTournament mutation.

Field
Type
Description
createdTournament
Tournament!
The created tournament information.
DataProvider
A data provider which provides external entity IDs.

Field
Type
Description
description
String
Description of the data provider.
name
String!
The name of the external data provider.
DeleteContentCatalogEntityPayload
The response for the deleteContentCatalogEntity mutation.

Field
Type
Description
contentCatalogVersionId
ID!
The version of the deleted content catalog entity.
id
ID!
The ID of the deleted content catalog entity.
DeleteContentCatalogVersionPayload
The response for the deleteContentCatalogVersion mutation.

Field
Type
Description
id
ID!
The ID of the deleted content catalog version.
DeletePlayerPayload
The ID of the removed player.

Field
Type
Description
id
ID!
The player ID.
DeletePlayerRolePayload
The response for the deletePlayerRole mutation.

Field
Type
Description
deletedPlayerRole
ID!
The ID of the deleted player role.
DeleteSeriesPayload
The ID of the removed series.

Field
Type
Description
id
ID!
The series ID.
DeleteTeamPayload
The ID of the removed team.

Field
Type
Description
id
ID!
The team ID.
DeleteTournamentPayload
The ID of the removed tournament.
Field
Type
Description
id
ID!
The tournament ID.
ExternalEntity
Information provided by the external data provider.

Field
Type
Description
id
ID!
The ID used by the external data provider.
ExternalLink
Linking information for an external data provider.

Field
Type
Description
dataProvider
DataProvider!
The external data provider.
externalEntity
ExternalEntity!
The external information.
Money
A monetary value.

Field
Type
Description
amount
Decimal!
The amount in USD.
Nationality
A player's nationality.

Field
Type
Description
code
String!
The ISO 3166-1 Alpha-3 code for the country (e.g., 'USA' for the United States).
name
String!
The full name of the country (e.g., 'United States').
Organization
An organization.

Field
Type
Description
id
ID!
The ID of the organization.
name
String!
The name of the organization.
private
Boolean!
The visibility status of the organization.
teams
[TeamRelation!]
The teams that belong to the organization.
OrganizationConnection
The result of querying a list of organizations. It provides pagination information.

Field
Type
Description
edges
[OrganizationEdge!]!
All players edges for query on a given page.
pageInfo
PageInfo!
Information about current page being pulled with query.
totalCount
Int!
Total count of players in the API.
OrganizationEdge
Organization and cursor information.

Field
Type
Description
cursor
Cursor!
Organizations cursor value for the edge.
node
Organization!
Organizations.
OrganizationRelation
An organization relation. Removes connection to Teams from the Organization.

Field
Type
Description
id
ID!
The ID of the organization.
name
String!
The name of the organization.
PageInfo
Information about current paginated data set position.

Field
Type
Description
endCursor
Cursor
The cursor of the last edge of the page.
hasNextPage
Boolean!
If there is a page after the one being returned.
hasPreviousPage
Boolean!
If there is a page before the one being returned.
startCursor
Cursor
The cursor of the first edge of the page.
Player
A player.

Field
Type
Description
id
ID!
The ID of a player
age
Int
The player's age.
externalLinks
[ExternalLink!]!
The external player IDs and providers.
fullName
String
The player's full name.
nationality
[Nationality!]!
The player's nationality.
nickname
String!
The name of the player.
private
Boolean!
The visibility status of the player.
team
Team
The team the player is currently playing.
title
Title!
The title the player is currently playing.
type
PlayerType!
The player's type.
PlayerConnection
The result of querying a list of players. It provides pagination information.

Field
Type
Description
edges
[PlayerEdge!]!
All players edges for query on a given page.
pageInfo
PageInfo!
Information about current page being pulled with query.
totalCount
Int!
Total count of players in the API.
PlayerEdge
Player and cursor information.
Field
Type
Description
cursor
Cursor!
Players cursor value for the edge.
node
Player!
Players.
PlayerRole
A player role

Field
Type
Description
id
ID!
The ID of a player role
name
String!
The name of the player role.
private
Boolean!
The visibility of this entity to other users.
title
Title!
The title of the player role.
ProductServiceLevel
The availability of a product for a given series.

Field
Type
Description
productName
String!
The name of the product.
serviceLevel
ServiceLevel!
The availability level for the product.
Series
A series.

Field
Type
Description
id
ID!
The ID of a series.
externalLinks
[ExternalLink!]!
The external series IDs and providers.
format
SeriesFormat!
The format of the series.
players
[Player!]!
The players participating in the series.
private
Boolean!
The visibility status of the series.
productServiceLevels
[ProductServiceLevel!]!
The service level for the series.
startTimeScheduled
DateTime!
The scheduled start time of the series.
streams
[VideoStream!]!
The list of stream URLs available for the series.
teams
[TeamParticipant!]!
The teams participating in the series.
title
Title!
The title being played in the series.
tournament
Tournament!
The tournament in which the series is being played.
type
SeriesType!
The type of the series.
SeriesConnection
The result of querying a list of series. It provides pagination information.

Field
Type
Description
edges
[SeriesEdge!]!
All series edges for query on a given page.
pageInfo
PageInfo!
Information about current page being pulled with query.
totalCount
Int!
Total count of series in the API.
SeriesEdge
Series and cursor information.

Field
Type
Description
cursor
Cursor!
Series cursor value for the edge.
node
Series!
Series.
SeriesFormat
The format of the series, such as: BO1, BO3, SA2.

Field
Type
Description
id
ID
The ID of the format.
name
String!
The name of a format.
nameShortened
String!
The shortened name of a format (max. 5 characters).
Team
A team.

Field
Type
Description
id
ID!
The ID of a team.
colorPrimary
HexColor!
The primary color of the team.
colorSecondary
HexColor!
The secondary color of the team.
externalLinks
[ExternalLink!]!
The external team IDs and providers.
logoUrl
Url!
The team logo URL.
name
String!
The name of the team.
nameShortened
String
The shortened name of a team.
organization
OrganizationRelation
The organization the team plays for.
private
Boolean!
The visibility status of the team.
rating
Float
The team rating.
title
Title!
Title the team is related to. 'titles' field will be removed soon and every team
will have a single title.
titles
[Title!]!
Use title field instead
TeamConnection
The result of querying a list of teams. It provides pagination information.

Field
Type
Description
edges
[TeamEdge!]!
All team edges for query on a given page.
pageInfo
PageInfo!
Information about current page being pulled with query.
totalCount
Int!
Total count of teams in the API.
TeamEdge
Team and cursor information.

Field
Type
Description
cursor
Cursor!
Team cursor value cursor value for the edge.
node
Team!
Team.
TeamParticipant
Team participating in the series.

Field
Type
Description
baseInfo
Team!
The team base information.
scoreAdvantage
Int!
The team score advantage for the team in the series.
TeamRelation
A team relation. Removes connection to Organization from the Team.

Field
Type
Description
colorPrimary
HexColor!
The primary color of the team.
colorSecondary
HexColor!
The secondary color of the team.
id
ID!
The ID of the team.
logoUrl
Url!
The team logo URL.
name
String!
The name of the team.
nameShortened
String
The shortened name of a team.
rating
Float
The team rating.
titles
[Title!]!
The titles the team is related to.
Title
A title.

Field
Type
Description
id
ID!
The ID of the title.
name
String!
The name of the title.
nameShortened
String!
The shortened name of the title (max. 20 characters).
private
Boolean
The visibility status of the title.
Tournament
A tournament.

Field
Type
Description
id
ID!
The ID of a tournament.
children
[Tournament!]!
The children tournament of the tournament.
endDate
Date
The end date of the tournament.
externalLinks
[ExternalLink!]!
The external tournament IDs and providers.
logoUrl
Url!
The tournament logo URL.
name
String!
The name of the tournament.
nameShortened
String!
The shortened name of the tournament (max. 30 characters).
parent
Tournament
The parent tournament of the tournament.
private
Boolean!
The visibility status of the tournament.
prizePool
Money
The tournament prize pool in USD.
startDate
Date
The start date of the tournament.
teams
[Team!]!
The teams linked to the tournament.
titles
[Title!]!
The titles linked to the tournament.
TournamentConnection
The result of querying a list of tournaments. It provides pagination information.

Field
Type
Description
edges
[TournamentEdge!]!
All tournament edges for query on a given page.
pageInfo
PageInfo!
Information about current page being pulled with query.
totalCount
Int!
Total count of tournaments in the API.
TournamentEdge
Tournament and cursor information.

Field
Type
Description
cursor
Cursor!
Tournament cursor value for the edge.
node
Tournament!
Tournament.
UpdateContentCatalogCharacterPayload
The response for the updateContentCatalogCharacter mutation.

Field
Type
Description
updatedContentCatalogCharacter
ContentCatalogCharacter!
The updated content catalog character information.
UpdateContentCatalogItemPayload
The response for the updateContentCatalogItem mutation.

Field
Type
Description
updatedContentCatalogItem
ContentCatalogItem!
The updated content catalog version information.
UpdateContentCatalogVersionPayload
The response for the updateContentCatalogVersion mutation.

Field
Type
Description
updatedContentCatalogVersion
ContentCatalogVersion!
The updated content catalog version information.
UpdatePlayerPayload
The response for the updatePlayer mutation.
Field
Type
Description
updatedPlayer
Player!
The updated player information.
UpdatePlayerRolePayload
The response for the updatePlayerRole mutation.

Field
Type
Description
updatedPlayerRole
PlayerRole!
The updated player role information.
UpdateSeriesPayload
The response for the updateSeries mutation.

Field
Type
Description
updatedSeries
Series!
The updated series information.
UpdateTeamPayload
The response for the updateTeam mutation.

Field
Type
Description
updatedTeam
Team!
The updated team information.
UpdateTournamentPayload
The response for the updateTournament mutation.

Field
Type
Description
updatedTournament
Tournament!
The updated tournament information.
VideoStream
Live video stream details.

Field
Type
Description
url
String!
URL link to live video stream.
Inputs
BooleanFilter
Boolean filter for true/false fields.

Field
Type
Description
equals
Boolean
Value to look for, can be nullable.
ContentCatalogEntityFilter
Content catalog entity selection filter.

Field
Type
Description
entityType
ContentCatalogEntityTypeFilter
Filter by content catalog entity type.
id
IdFilter
Filter by content catalog entity id.
name
StringFilter
Filter by content catalog entity name.
private
BooleanFilter
Filter by entity visibility.
title
ContentCatalogEntityTitleFilter
Filter by content catalog entity title.
ContentCatalogEntityTitleFilter
Filter by content catalog entity title.

Field
Type
Description
id
IdFilter
Filter by content catalog entity title id.
ContentCatalogEntityTypeFilter
Filter by content catalog entity type.

Field
Type
Description
in
[ContentCatalogEntityType!]!
Filter by content catalog entity type.
ContentCatalogVersionFilter
Filter by a content catalog version.

Field
Type
Description
name
StringFilter
Filter by content catalog version name.
private
BooleanFilter
Filter by version visibility.
publishedOn
DateTimeFilter
Filter by content catalog version published date.
title
ContentCatalogVersionTitleFilter
Filter by content catalog title.
ContentCatalogVersionOrder
Ordering options for content catalog versions results.

Field
Type
Description
direction
OrderDirection!
The ordering direction.
field
ContentCatalogVersionOrderField!
The field to order the content catalog entities versions by.
ContentCatalogVersionTitleFilter
Filter by a content catalog version title.

Field
Type
Description
id
IdFilter
Filter by title ID.
CreateContentCatalogCharacterInput
The fields used to create a new content catalog character or a version of an
existing character.

Field
Type
Description
contentCatalogVersionId
ID!
The ID of the content catalog version the character should be linked to.
externalLinks
[ExternalLinkInput!]
The external character IDs.
id
ID
The UUID of an existing character to create a new version of it. If not passed, a
new character will be created.
imageData
String
The image encoded as base64 string. If not provided, it defaults to a placeholder
image.
name
String
The name of the character. Optional if creating a version of an existing character.
private
Boolean
The visibility of this entity to other users.
CreateContentCatalogItemInput
The fields used to create a new content catalog item or a version of an existing
item.

Field
Type
Description
contentCatalogVersionId
ID!
The version of the content catalog the item should be linked to.
cost
Float
The cost of the item. When not provided, it defaults to 0.
externalLinks
[ExternalLinkInput!]
The external item IDs.
id
ID
The UUID of an existing item to create a new version of it.If not passed, a new
item will be created.
imageData
String
The image encoded as base64 string.If not provided, it defaults to a placeholder
image.
name
String
The name of the item.Optional if creating a version of an existing item.
private
Boolean
The visibility of this entity to other users.
CreateContentCatalogVersionInput
The fields used to create a content catalog version.

Field
Type
Description
externalLinks
[ExternalLinkInput!]!
The external content catalog version ids.
name
String!
The UNIQUE name of the content catalog version.
private
Boolean
The visibility of this entity to other users.
publishedOn
DateTime!
The date and time when the catalog version becomes effective.
titleId
ID!
The ID of the title for the content catalog version.
CreatePlayerInput
The fields used to create a player.

Field
Type
Description
externalLinks
[ExternalLinkInput!]!
The external player IDs.
nickname
String!
The nickname of the player. Must be unique and limited to 100 characters.
private
Boolean
The visibility of this entity to other users.
role
[CreatePlayerPlayerRoleInput!]!
The player's roles.
team
CreatePlayerTeamInput!
The team the player belongs to.
title
CreatePlayerTitleInput!
The title the player participates in.
CreatePlayerPlayerRoleInput
The player role field used to create a player.

Field
Type
Description
id
ID!
The ID of the player role for the player.
CreatePlayerRoleInput
The fields used to create a new player role.

Field
Type
Description
name
String!
The player role name.
private
Boolean
The visibility of this entity to other users.
title
CreatePlayerRoleTitleInput!
The player role title.
CreatePlayerRoleTitleInput
Field
Type
Description
titleId
ID!
None
CreatePlayerTeamInput
The team field used to create a player.

Field
Type
Description
teamId
ID!
The ID of the team for the player.
CreatePlayerTitleInput
The title field used to create a player.

Field
Type
Description
titleId
ID!
The ID of the title for the player.
CreateSeriesFormatInput
The format fields used to create a series.

Field
Type
Description
id
ID!
The series format identifier. Check available formats via SeriesFormat query.
CreateSeriesInput
The fields used to create a series.

Field
Type
Description
externalLinks
[ExternalLinkInput!]!
The external series IDs.
format
CreateSeriesFormatInput!
The series format i.a. best-of-3 (Bo3), score-after-2 (SA2). Referenced by ID.
players
[CreateSeriesParticipatingPlayersInput!]!
The players participating in the series being created.
private
Boolean
The visibility of this entity to other users.
startTimeScheduled
DateTime!
The start time in UTC of this series, formatted as an ISO date string. For example:
2023-04-12T12:12:37-03:00.
teams
[CreateSeriesTeamInput!]!
The teams playing in the series.
title
CreateSeriesTitleInput!
The title for the series.
tournament
CreateSeriesTournamentInput!
The tournament for the series.
CreateSeriesParticipatingPlayersInput
A player participating in the series being created.

Field
Type
Description
id
ID!
The player ID.
CreateSeriesTeamInput
The team fields used to create a series.

Field
Type
Description
scoreAdvantage
Int!
The score advantage for the team in this series.
teamId
ID!
The ID of the team playing in the series.
CreateSeriesTitleInput
The title fields used to create a series.
Field
Type
Description
titleId
ID!
The ID of the title for the series.
CreateSeriesTournamentInput
The tournament fields used to create a series.

Field
Type
Description
tournamentId
ID!
The ID of the tournament for the series.
CreateTeamInput
The fields used to create a team.

Field
Type
Description
colorPrimary
HexColor!
The team's primary color in hexadecimal. Defaults to grey.
colorSecondary
HexColor!
The team's secondary color in hexadecimal. Defaults to white.
externalLinks
[ExternalLinkInput!]!
The external team IDs.
logoData
String
The logo of the team. Has to be a Base64 encoded image, supported types: image/jpg,
image/jpeg, image/png, image/gif, image/svg+xml, image/webp.
name
String!
The name of the team. Must be unique and limited to 100 characters.
nameShortened
String
The shortened name of the team. It's limited to 20 characters and it's not unique.
private
Boolean
The visibility of this entity to other users.
title
CreateTeamTitleInput!
The title the team participates in.
CreateTeamTitleInput
The title fields used to create a team.

Field
Type
Description
titleId
ID!
The ID of the title for the team.
CreateTournamentInput
The fields used to create a tournament.
Field
Type
Description
endDate
DateInput
The end date of the tournament formatted as ISO 8601 i.e. yyyy-MM-dd
externalLinks
[ExternalLinkInput!]!
The external tournament IDs.
logoData
String
The logo of the tournament. Has to be a Base64 encoded image, supported types:
image/jpg, image/jpeg, image/png, image/gif, image/svg+xml, image/webp.
name
String!
The name of the tournament. Must be unique and limited to 150 characters.
nameShortened
String!
The short name of the tournament. Must be unique and limited to 30 characters.
parent
CreateTournamentParentInput
The parent tournament of the tournament
private
Boolean
The visibility of this entity to other users.
prizePool
MoneyInput
The prize pool of the tournament in USD.
startDate
DateInput
The start date of the tournament formatted as ISO 8601 i.e. yyyy-MM-dd
teams
[CreateTournamentTeamInput!]!
The participating teams of the tournament.
titles
[CreateTournamentTitleInput!]!
The titles being played in the tournament.
CreateTournamentParentInput
The parent tournament fields used to create a tournament together with a parent.

Field
Type
Description
tournamentId
ID!
The ID of the parent tournament
CreateTournamentTeamInput
The team fields used to update a tournament.

Field
Type
Description
teamId
ID!
The ID of the team for the tournament.
CreateTournamentTitleInput
The title fields used to create a tournament.

Field
Type
Description
titleId
ID!
The ID of the title for the tournament.
DateInput
Field
Type
Description
date
Date
ISO 8601 formatted date i.e. yyyy-MM-dd
DateTimeFilter
Filter by a datetime range.

Field
Type
Description
gte
String
DateTime for the beginning of the time range (optional), formatted as an ISO date
string. Time window includes the given value.
lte
String
DateTime for the end of the time range (optional), formatted as an ISO date string.
Time window includes the given value.
DeletePlayerInput
The ID of the player to delete.

Field
Type
Description
id
ID!
The player ID.
DeletePlayerRoleInput
The fields used to delete a player role.

Field
Type
Description
id
ID!
The ID of the player role to be deleted.
DeleteSeriesInput
The ID of the series to delete.

Field
Type
Description
id
ID!
The series ID.
DeleteTeamInput
The ID of the team to delete.

Field
Type
Description
id
ID!
The team ID.
DeleteTournamentInput
The ID of the tournament to delete.

Field
Type
Description
id
ID!
The tournament ID.
ExternalEntityInput
The field for the external ID value.

Field
Type
Description
id
ID!
The external ID value.
ExternalLinkInput
The fields the external entity consist of.

Field
Type
Description
dataProviderName
String!
The data provider name. Strict control over possible values.
externalEntityInput
ExternalEntityInput!
The external id value.
GameFilter
Filter for series by game data points.

Field
Type
Description
id
IdFilter
Filter by game IDs.
map
MapFilter
Filter by game map.
IdFilter
ID filter for entity identifiers.

Field
Type
Description
in
[ID!]
Array of IDs to look for.
IntFilter
Filter by integer value or range.

Field
Type
Description
equals
Int
Filter by value equal.
gte
Int
Filter by value greater than or equal.
lte
Int
Filter by value less than or equal.
MapFilter
Filter for map data points.

Field
Type
Description
name
StringFilter
Filter by map name.
MoneyInput
Field
Type
Description
amount
Decimal
The amount of the prize pool.
NationalityFilter
Filter by player nationality.

Field
Type
Description
code
StringFilter
Filter by nationality code.
name
StringFilter
Filter by nationality name.
NullableDateFilter
Filter by a date range. If both 'gte' and 'lte' are null, it'll fetch the entities
for which the field the filter is applied to is null.

Field
Type
Description
gte
Date
Date for the beginning of the time range (optional), formatted as an ISO date
string. Time window includes the given value.
lte
Date
Date for the end of the time range (optional), formatted as an ISO date string.
Time window includes the given value.
NullableIdFilter
ID filter with nullable value.

Field
Type
Description
id
ID
ID to look for, can be nullable.
OrganizationFilter
Filter for organization by data points.

Field
Type
Description
name
StringFilter
Limits results by string filter of organization's name.
private
BooleanFilter
Filter by organization visibility.
PlayerFilter
Filter for player data points.

Field
Type
Description
age
IntFilter
Filter by age.
fullName
StringFilter
Filter by full name.
nationality
NationalityFilter
Filter by nationality.
nickname
StringFilter
Filter by the player's nickname.
private
BooleanFilter
Filter by player visibility.
roles
PlayerPlayerRoleFilter
Filter players by role.
teamIdFilter
NullableIdFilter
Filter by a specific team ID. If this is null, no filter will be applied. If
titleId
ID
Filter by a specific title ID.
types
[PlayerType!]
Filter by player type.
PlayerPlayerRoleFilter
Filter by player role.

Field
Type
Description
name
StringFilter
Filter by player role name.
title
PlayerRoleTitleFilter
Filter by player role title.
PlayerRoleFilter
Filter by player role.

Field
Type
Description
name
StringFilter
Filter by player role name.
title
PlayerRoleTitleFilter
Filter by player role title.
PlayerRoleTitleFilter
Filter player roles by title.

Field
Type
Description
id
IdFilter!
Filter player roles by title ID.
ProductServiceLevelFilter
Filters for series by product and/or by service level.

Field
Type
Description
productName
String!
The name of the product to filter by.
serviceLevel
ServiceLevel!
The availability level to filter by.
SeriesFilter
Filter for series data points.

Field
Type
Description
live
SeriesLiveFilter
Filter by live data points.
livePlayerIds
IdFilter
Filter by participating player IDs.
players
SeriesPlayerFilter
Filter by participating players data points.
private
BooleanFilter
Filter by series visibility.
productServiceLevels
ProductServiceLevelFilter
Filter by product service levels.
startTimeScheduled
DateTimeFilter
Filter by a time range.
teamId
ID
Use teamIds filter instead
teamIds
IdFilter
Filter by team IDs.
titleId
ID
Use titleIds filter instead
titleIds
IdFilter
Filter by title IDs.
tournament
SeriesTournamentFilter
Filter by tournament data points.
tournamentId
ID
Use the tournament filter instead
tournamentIds
IdFilter
Use the tournament filter instead
type
SeriesType
Use types filter instead
types
[SeriesType!]
Filter by series types.
SeriesLiveFilter
Filter for series by live data points.

Field
Type
Description
games
GameFilter
Filter by game.
SeriesPlayerFilter
Filter series by participating players data points.

Field
Type
Description
age
IntFilter
Filter series where at least one participant's age meets the specified criteria.
SeriesTournamentFilter
Filter for series by tournament data points.

Field
Type
Description
endDate
NullableDateFilter
Filter by tournament end date.
id
IdFilter
Filter by tournament IDs.
includeChildren
BooleanFilter
Include children tournaments in the filter.
name
StringFilter
Filter by tournament name.
nameShortened
StringFilter
Filter by tournament shortened name.
startDate
NullableDateFilter
Filter by tournament start date.
title
SeriesTournamentTitleFilter
Filter by tournament titles data points.
SeriesTournamentTitleFilter
Filter for series by the tournament title data points.

Field
Type
Description
id
IdFilter
Array of IDs to look for.
StringFilter
String filter for character-based fields.

Field
Type
Description
contains
String
Case-insensitive string filter to match field containing it.
equals
String
Case-insensitive string filter to match field exactly it.
TeamFilter
Filter for team data points.

Field
Type
Description
name
StringFilter
Filter by the team's name.
nameShortened
StringFilter
Filter by the team's shortened name.
organizationId
ID
Filter by a specific organization.
private
BooleanFilter
Filter by team visibility.
titleId
ID
Filter by a specific title.
TitleFilter
Filter for titles.

Field
Type
Description
private
BooleanFilter
Filter by title visibility.
TournamentFilter
Filter for tournament data points.

Field
Type
Description
endDate
NullableDateFilter
Filter by tournament end date.
hasChildren
BooleanFilter
Filter tournaments that have children. If false, only tournaments at the bottom-
most level of the hierarchy are returned.
hasParent
BooleanFilter
Filter tournaments that have parents. If false, only tournaments at the top-most
level of the hierarchy are returned.
name
StringFilter
Filter by tournament name.
nameShortened
StringFilter
Filter by tournament short name.
private
BooleanFilter
Filter by tournaments visibility.
startDate
NullableDateFilter
Filter by tournament start date.
title
TournamentTitleFilter
Filter by tournament titles.
titleId
ID
Use the titles filter instead
TournamentTitleFilter
Filter for tournaments by title data points.

Field
Type
Description
id
IdFilter
Filter by tournament IDs.
UpdateContentCatalogCharacterInput
The fields used to update a new content catalog character or a version of an
existing character.

Field
Type
Description
contentCatalogVersionId
ID!
The content catalog version.
externalLinks
[ExternalLinkInput!]
The external character IDs. Overwrites all the previous values.
id
ID!
The UUID of an existing character.
imageData
String
The image encoded as base64 string. If not provided, it defaults to a placeholder
image.
name
String
The new name of the character.
private
Boolean
The visibility of this entity to other users.
UpdateContentCatalogItemInput
The fields used to create a new content catalog item or a version of an existing
item.

Field
Type
Description
contentCatalogVersionId
ID!
The content catalog version.
cost
Float
The new cost of the item.
externalLinks
[ExternalLinkInput!]
The external item IDs. Overrides all previous values.
id
ID!
The UUID of an existing item.
imageData
String
The new base64 encoded image of the item.
name
String
The new name of the item.
private
Boolean
The visibility of this entity to other users.
UpdateContentCatalogVersionInput
The fields used to update a content catalog version.

Field
Type
Description
contentCatalogVersionId
ID!
The unique identifier of the content catalog version.
private
Boolean
The visibility of this entity to other users.
UpdateContentCatalogVersionOwnerInput
The fields used to update item's owners

Field
Type
Description
ownerId
ID!
The owner's ID.
UpdatePlayerInput
The fields used to update a player.

Field
Type
Description
externalLinks
[ExternalLinkInput!]
The external player IDs. Overrides all previous values.
id
ID!
The ID of the player.
nickname
String
The nickname of the player. Must be unique and limited to 100 characters.
private
Boolean
The visibility of this entity to other users.
role
[UpdatePlayerPlayerRoleInput!]
The player's roles.
team
UpdatePlayerTeamInput
The team the player belongs to. Overrides previous value.
title
UpdatePlayerTitleInput
The title the player participates in. Overrides previous value.
UpdatePlayerPlayerRoleInput
The player role field used to update a player.

Field
Type
Description
id
ID!
The ID of the player role for the player.
UpdatePlayerRoleInput
The fields used to update a player role.

Field
Type
Description
id
ID!
The ID of the player role to be updated.
name
String
The new role name.
private
Boolean
The visibility of this entity to other users.
UpdatePlayerRoleTitleInput
Field
Type
Description
titleId
ID!
None
UpdatePlayerTeamInput
The team field used to update a player.

Field
Type
Description
teamId
ID
The ID of the team for the player.
UpdatePlayerTitleInput
The title field used to update a player.

Field
Type
Description
titleId
ID!
The ID of the title for the player.
UpdateSeriesFormatInput
The format fields used to update a series.

Field
Type
Description
id
ID!
The series format identifier. Check available formats via SeriesFormat query.
UpdateSeriesInput
The fields used to update a series.

Field
Type
Description
externalLinks
[ExternalLinkInput!]
The external series IDs. Overrides all previous values.
format
UpdateSeriesFormatInput
The new series format i.a. best-of-3 (Bo3), score-after-2 (SA2). Referenced by ID.
id
ID!
The ID of the series.
players
[UpdateSeriesParticipatingPlayersInput!]
The players participating in the series being updated.
private
Boolean
The visibility of this entity to other users.
startTimeScheduled
DateTime
The new start time in UTC of this series, formatted as an ISO date string. For
example: 2023-04-12T12:12:37-03:00.
teams
[UpdateSeriesTeamInput!]
The new teams for the series. Overrides the previous value.
title
UpdateSeriesTitleInput
The new title for the series.
tournament
UpdateSeriesTournamentInput
The new tournament for the series.
UpdateSeriesParticipatingPlayersInput
A player participating in the series being updated.

Field
Type
Description
id
ID!
The player ID.
UpdateSeriesTeamInput
The team fields used to update a series.

Field
Type
Description
scoreAdvantage
Int!
The score advantage for the team in this series.
teamId
ID!
The ID of the team playing in the series.
UpdateSeriesTitleInput
The title fields used to update a series.

Field
Type
Description
titleId
ID!
The ID of the title for the series.
UpdateSeriesTournamentInput
The tournament fields used to update a series.

Field
Type
Description
tournamentId
ID!
The ID of the tournament for the series.
UpdateTeamInput
The fields used to update a team.

Field
Type
Description
colorPrimary
HexColor
The new team's primary color in hexadecimal. Defaults to grey.
colorSecondary
HexColor
The new team's secondary color in hexadecimal. Defaults to white.
externalLinks
[ExternalLinkInput!]
The external team IDs. Overrides all previous values.
id
ID!
The ID of the team.
logoData
String
The new logo of the team. Has to be a Base64 encoded image, supported types:
image/jpg, image/jpeg, image/png, image/gif, image/svg+xml, image/webp.
name
String
The new name of the team. Must be unique and limited to 100 characters.
nameShortened
String
The new shortened name of the team. It's limited to 20 characters and it's not
unique.
private
Boolean
The visibility of this entity to other users.
title
UpdateTeamTitleInput
The title the team participates in. Overrides previous value.
UpdateTeamTitleInput
The title fields used to update a team.

Field
Type
Description
titleId
ID!
The ID of the title for the team.
UpdateTournamentInput
The fields used to update a tournament.

Field
Type
Description
endDate
DateInput
The end date of the tournament formatted as ISO 8601 i.e. yyyy-MM-dd
externalLinks
[ExternalLinkInput!]
The external tournament IDs. Overrides all previous values.
id
ID!
The ID of the tournament.
logoData
String
The new logo of the tournament. Has to be a Base64 encoded image, supported types:
image/jpg, image/jpeg, image/png, image/gif, image/svg+xml, image/webp.
name
String
The new name of the tournament. Must be unique and limited to 150 characters.
nameShortened
String
The new short name of the tournament. Must be unique and limited to 30 characters.
parent
UpdateTournamentParentInput
The parent tournament of the tournament
private
Boolean
The visibility of this entity to other users.
prizePool
MoneyInput
The prize pool of the tournament in USD.
startDate
DateInput
The start date of the tournament formatted as ISO 8601 i.e. yyyy-MM-dd
teams
[UpdateTournamentTeamInput!]
The new teams that will be playing in the tournament. Overrides previous value.
titles
[UpdateTournamentTitleInput!]
The new titles being played in the tournament. Overrides previous value.
UpdateTournamentParentInput
The parent tournament fields used to create a tournament together with a parent.

Field
Type
Description
tournamentId
ID
None
UpdateTournamentTeamInput
The team fields used to update a tournament.

Field
Type
Description
teamId
ID!
The ID of the team for the tournament.
UpdateTournamentTitleInput
The title fields used to update a tournament.

Field
Type
Description
titleId
ID!
The ID of the title for the tournament.
Interfaces
ContentCatalogEntity
A content catalog entity.

Field
Type
Description
contentCatalogVersion
ContentCatalogVersion!
The content catalog version this entity appears in.
id
ID!
The ID of the content catalog entity.
imageUrl
Url!
The URL to the content catalog entity's image
name
String!
The name of the content catalog entity.
private
Boolean
The visibility of this entity to other users.
OrganizationInterface
An interface for organization types.

Field
Type
Description
id
ID!
The ID of the organization.
name
String!
The name of the organization.
TeamInterface
An interface for team types.

Field
Type
Description
colorPrimary
HexColor!
The primary color of the team.
colorSecondary
HexColor!
The secondary color of the team.
id
ID!
The ID of the team.
logoUrl
Url!
The team logo URL.
name
String!
The name of the team.
nameShortened
String
The shortened name of a team.
rating
Float
The team rating.
titles
[Title!]!
The titles the team is related to.
Enums
ContentCatalogEntityType
The type of a content catalog entity.

Field
Description
CHARACTER
Content catalog character.
ITEM
Content catalog item.
ContentCatalogVersionOrderField
The field which the result will be ordered by.
Field
Description
PUBLISHED_ON
Order by publishedOn.
TITLE
Order by title name.
ErrorDetail
Field
Description
DEADLINE_EXCEEDED
The deadline expired before the operation could complete. For operations that
change the state of the system, this error may be returned even if the operation
has completed successfully. For example, a successful response from a server could
have been delayed long enough for the deadline to expire. HTTP Mapping: 504 Gateway
Timeout Error Type: UNAVAILABLE
ENHANCE_YOUR_CALM
The server detected that the client is exhibiting a behavior that might be
generating excessive load. HTTP Mapping: 429 Too Many Requests or 420 Enhance Your
Calm Error Type: UNAVAILABLE
FIELD_NOT_FOUND
The requested field is not found in the schema. This differs from
INVALID_ARGUMENT
The client specified an invalid argument. Note that this differs from
INVALID_CURSOR
The provided cursor is not valid. The most common usage for this error is when a
client is paginating through a list that uses stateful cursors. In that case, the
provided cursor may be expired. HTTP Mapping: 404 Not Found Error Type: NOT_FOUND
MISSING_RESOURCE
Unable to perform operation because a required resource is missing. Example: Client
is attempting to refresh a list, but the specified list is expired. This requires
an action by the client to get a new list. If the user is simply trying GET a
resource that is not found, use the NOT_FOUND error type.
FAILED_PRECONDITION.MISSING_RESOURCE is to be used particularly when the user is
performing an operation that requires a particular resource to exist. HTTP Mapping:
400 Bad Request or 500 Internal Server Error Error Type: FAILED_PRECONDITION
SERVICE_ERROR
Service Error. There is a problem with an upstream service. This may be returned if
a gateway receives an unknown error from a service or if a service is unreachable.
If a request times out which waiting on a response from a service,
TCP_FAILURE
Request failed due to network errors. HTTP Mapping: 503 Unavailable Error Type:
UNAVAILABLE
THROTTLED_CONCURRENCY
Request throttled based on server concurrency limits. HTTP Mapping: 503 Unavailable
Error Type: UNAVAILABLE
THROTTLED_CPU
Request throttled based on server CPU limits HTTP Mapping: 503 Unavailable. Error
Type: UNAVAILABLE
UNIMPLEMENTED
The operation is not implemented or is not currently supported/enabled. HTTP
Mapping: 501 Not Implemented Error Type: BAD_REQUEST
UNKNOWN
Unknown error. This error should only be returned when no other error detail
applies. If a client sees an unknown errorDetail, it will be interpreted as
UNKNOWN. HTTP Mapping: 500 Internal Server Error
ErrorType
Field
Description
BAD_REQUEST
Bad Request. There is a problem with the request. Retrying the same request is not
likely to succeed. An example would be a query or argument that cannot be
deserialized. HTTP Mapping: 400 Bad Request
FAILED_PRECONDITION
The operation was rejected because the system is not in a state required for the
operation's execution. For example, the directory to be deleted is non-empty, an
rmdir operation is applied to a non-directory, etc. Service implementers can use
the following guidelines to decide between
INTERNAL
Internal error. An unexpected internal error was encountered. This means that some
invariants expected by the underlying system have been broken. This error code is
reserved for serious errors. HTTP Mapping: 500 Internal Server Error
NOT_FOUND
The requested entity was not found. This could apply to a resource that has never
existed (e.g. bad resource id), or a resource that no longer exists (e.g. cache
expired.) Note to server developers: if a request is denied for an entire class of
users, such as gradual feature rollout or undocumented allowlist,
PERMISSION_DENIED
The caller does not have permission to execute the specified operation.
UNAUTHENTICATED
The request does not have valid authentication credentials. This is intended to be
returned only for routes that require authentication. HTTP Mapping: 401
Unauthorized
UNAVAILABLE
Currently Unavailable. The service is currently unavailable. This is most likely a
transient condition, which can be corrected by retrying with a backoff. HTTP
Mapping: 503 Unavailable
UNKNOWN
Unknown error. For example, this error may be returned when an error code received
from another address space belongs to an error space that is not known in this
address space. Also errors raised by APIs that do not return enough error
information may be converted to this error. If a client sees an unknown errorType,
it will be interpreted as UNKNOWN. Unknown errors MUST NOT trigger any special
behavior. These MAY be treated by an implementation as being equivalent to
INTERNAL. When possible, a more specific error should be provided. HTTP Mapping:
520 Unknown Error
OrderDirection
Order in which the results will be provided.

Field
Description
ASC
Orders the results ascending.
DESC
Orders the results descending.
PlayerType
The type of player being returned.

Field
Description
ESPORTS
An esports player.
REGULAR
A non-esports player.
SeriesOrderBy
Field to order results by.

Field
Description
ID
Orders the series result by ID.
StartTimeScheduled
Orders the series result by the scheduled start time.
SeriesType
The type of series being returned.

Field
Description
COMPETITIVE
A competitive non-esports series.
ESPORTS
A competitive series.
LOOPFEED
A GRID test game that gets played repeatedly in a loop.
SCRIM
A practice series.
ServiceLevel
The availability level for a given product.

Field
Description
FULL
The product service is fully available.
LIMITED
Some functionalities of the product service may be limited or unavailable.
NONE
The product service is not available.
Scalars
Boolean
The Boolean scalar type represents true or false.

Cursor
Cursor value for pagination.

Date
Date formatted as ISO 8601.

DateTime
DateTime formatted as ISO 8601.

Decimal
Decimal number representation.

Float
The Float scalar type represents signed double-precision fractional values as
specified by IEEE 754.

HexColor
Hexadecimal value of an RGB color.

ID
The ID scalar type represents a unique identifier, often used to refetch an object
or as key for a cache. The ID type appears in a JSON response as a String; however,
it is not intended to be human-readable. When expected as an input type, any string
(such as "4") or integer (such as 4) input value will be accepted as an ID.

Int
The Int scalar type represents non-fractional signed whole numeric values. Int can
represent values between -(2^31) and 2^31 - 1.

String
The String scalar type represents textual data, represented as UTF-8 character
sequences. The String type is most often used by GraphQL to represent free-form
human-readable text.

Url
URL pointing to resource.

You might also like