Circuit API › Tournaments

Returns the list of tournaments associated of the given circuit.

Resource URL

https://api.toornament.com/circuit/v2/circuits/{circuit_id}/tournaments

HTTP headers

• X-Api-Key

  string

  API key of your application (see Authentication)

• Authorization

  string

  Access token with organizer:circuit scope (see Authorization)

Path parameters

• circuit_id

  string

  The id of the circuit.

Query Parameters

This endpoint does not have any query parameters.

Request Body

This endpoint does not require a request body.

Response

[206] Tournaments classification retrieved.

Example

[
    {
        "season": "open_winter_2022",
        "region": "europe",
        "tier": "tier_1",
        "tournament_id": "5617559294676615168"
    }
]

Structure (collection)

• season

  string|null

  The machine name of the season.

  Example: "open_winter_2022"

• region

  string|null

  The machine name of the region.

  Example: "europe"

• tier

  string|null

  The machine name of the tier.

  Example: "tier_1"

• tournament_id

  string

  The unique identifier of the tournament.

  Example: "5617559294676615168"

Create a new classification between circuit and tournament.

Resource URL

https://api.toornament.com/circuit/v2/circuits/{circuit_id}/tournaments

HTTP headers

• X-Api-Key

  string

  API key of your application (see Authentication)

• Authorization

  string

  Access token with organizer:circuit scope (see Authorization)

Path parameters

• circuit_id

  string

  The id of the circuit.

Query Parameters

This endpoint does not have any query parameters.

Request Body

Tournaments classification data.

Example

{
    "season": "open_winter_2022",
    "region": "europe",
    "tier": "tier_1",
    "tournament_id": "5617559294676615168"
}

Structure (object)

• season

  string|null

  Optional

  The machine name of the season.

  Example: "open_winter_2022"

• region

  string|null

  Optional

  The machine name of the region.

  Example: "europe"

• tier

  string|null

  Optional

  The machine name of the tier.

  Example: "tier_1"

• tournament_id

  string

  The unique identifier of the circuit.

  Example: "5617559294676615168"

Response

[201] Circuit tournament created.

Example

{
    "season": "open_winter_2022",
    "region": "europe",
    "tier": "tier_1",
    "tournament_id": "5617559294676615168"
}

Structure (object)

• season

  string|null

  The machine name of the season.

  Example: "open_winter_2022"

• region

  string|null

  The machine name of the region.

  Example: "europe"

• tier

  string|null

  The machine name of the tier.

  Example: "tier_1"

• tournament_id

  string

  The unique identifier of the tournament.

  Example: "5617559294676615168"

Returns a single classification identified with the given circuit and tournament identifier.

Resource URL

https://api.toornament.com/circuit/v2/circuits/{circuit_id}/tournaments/{id}

HTTP headers

• X-Api-Key

  string

  API key of your application (see Authentication)

• Authorization

  string

  Access token with organizer:circuit scope (see Authorization)

Path parameters

• circuit_id

  string

  The id of the circuit.

• id

  string

  The id of the tournament.

Query Parameters

This endpoint does not have any query parameters.

Request Body

This endpoint does not require a request body.

Response

[200] Circuit tournament retrieved.

Example

{
    "season": "open_winter_2022",
    "region": "europe",
    "tier": "tier_1",
    "tournament_id": "5617559294676615168"
}

Structure (object)

• season

  string|null

  The machine name of the season.

  Example: "open_winter_2022"

• region

  string|null

  The machine name of the region.

  Example: "europe"

• tier

  string|null

  The machine name of the tier.

  Example: "tier_1"

• tournament_id

  string

  The unique identifier of the tournament.

  Example: "5617559294676615168"

Updates classifications.

Resource URL

https://api.toornament.com/circuit/v2/circuits/{circuit_id}/tournaments/{id}

HTTP headers

• X-Api-Key

  string

  API key of your application (see Authentication)

• Authorization

  string

  Access token with organizer:circuit scope (see Authorization)

Path parameters

• circuit_id

  string

  The id of the circuit.

Query Parameters

This endpoint does not have any query parameters.

Request Body

Circuit tournament data.

Example

{
    "season": "open_winter_2022",
    "region": "europe",
    "tier": "tier_1"
}

Structure (object)

• season

  string|null

  Optional

  The machine name of the season.

  Example: "open_winter_2022"

• region

  string|null

  Optional

  The machine name of the region.

  Example: "europe"

• tier

  string|null

  Optional

  The machine name of the tier.

  Example: "tier_1"

Response

[200] Success.

Example

{
    "season": "open_winter_2022",
    "region": "europe",
    "tier": "tier_1",
    "tournament_id": "5617559294676615168"
}

Structure (object)

• season

  string|null

  The machine name of the season.

  Example: "open_winter_2022"

• region

  string|null

  The machine name of the region.

  Example: "europe"

• tier

  string|null

  The machine name of the tier.

  Example: "tier_1"

• tournament_id

  string

  The unique identifier of the tournament.

  Example: "5617559294676615168"

Deletes your classification identified by the given circuit and tournament identifier.

Resource URL

https://api.toornament.com/circuit/v2/circuits/{circuit_id}/tournaments/{id}

HTTP headers

• X-Api-Key

  string

  API key of your application (see Authentication)

• Authorization

  string

  Access token with organizer:circuit scope (see Authorization)

Path parameters

• circuit_id

  string

  The id of the circuit.

Query Parameters

This endpoint does not have any query parameters.

Request Body

This endpoint does not require a request body.

Response

[204] Success.