Circuit API › Tournaments

Download OpenAPI 3.0

Endpoints

GET /circuits/{circuit_id}/tournaments

Returns the list of tournaments associated to 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)

  • Range
    string

    A range of requested items using the tournaments unit. The size of the range can not exceed 50. (see Pagination)

    Example: tournaments=0-49

Path parameters

  • circuit_id
    string

    The id of the circuit.

Query Parameters

  • season_ids
    array

    Only return tournaments for the given list of season ids.

    Example: 5617559294676615168,5629045554450433513

  • region_ids
    array

    Only return tournaments for the given list of region ids.

    Example: 5617559294676615127,5629045554450325504

  • tier_ids
    array

    Only return tournaments for the given list of tier ids.

    Example: 5629012354450701104,5629045224110325121

Request Body

This endpoint does not require a request body.

Response

[206] Tournaments retrieved.

Example
[
    {
        "tournament_id": "5617559294676615168",
        "season_id": "5617559294676615168",
        "region_id": "5629045554450325504",
        "tier_id": "5629012354450701104"
    }
]
Structure (collection)
  • tournament_id
    string

    The unique identifier of the tournament.

    Example: "5617559294676615168"

  • season_id
    string|null

    The id of the season contained in this circuit.

    Example: "5617559294676615168"

  • region_id
    string|null

    The id of the region contained in this circuit.

    Example: "5629045554450325504"

  • tier_id
    string|null

    The id of the tier contained in this circuit.

    Example: "5629012354450701104"

POST /circuits/{circuit_id}/tournaments

Associates a tournament to a circuit, with its saison, region and tier classifications.

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
{
    "tournament_id": "5617559294676615168",
    "season_id": "5617559294676615168",
    "region_id": "5629045554450325504",
    "tier_id": "5629012354450701104"
}
Structure (object)
  • tournament_id
    string

    The unique identifier of the circuit.

    Example: "5617559294676615168"

  • season_id
    string|null

    Optional

    The id of the season contained in this circuit.

    Example: "5617559294676615168"

  • region_id
    string|null

    Optional

    The id of the region contained in this circuit.

    Example: "5629045554450325504"

  • tier_id
    string|null

    Optional

    The id of the tier contained in this circuit.

    Example: "5629012354450701104"

Response

[201] Tournament associated.

Example
{
    "tournament_id": "5617559294676615168",
    "season_id": "5617559294676615168",
    "region_id": "5629045554450325504",
    "tier_id": "5629012354450701104"
}
Structure (object)
  • tournament_id
    string

    The unique identifier of the tournament.

    Example: "5617559294676615168"

  • season_id
    string|null

    The id of the season contained in this circuit.

    Example: "5617559294676615168"

  • region_id
    string|null

    The id of the region contained in this circuit.

    Example: "5629045554450325504"

  • tier_id
    string|null

    The id of the tier contained in this circuit.

    Example: "5629012354450701104"

GET /circuits/{circuit_id}/tournaments/{id}

Returns the classification of a single tournament in the given circuit.

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] Classification retrieved.

Example
{
    "tournament_id": "5617559294676615168",
    "season_id": "5617559294676615168",
    "region_id": "5629045554450325504",
    "tier_id": "5629012354450701104"
}
Structure (object)
  • tournament_id
    string

    The unique identifier of the tournament.

    Example: "5617559294676615168"

  • season_id
    string|null

    The id of the season contained in this circuit.

    Example: "5617559294676615168"

  • region_id
    string|null

    The id of the region contained in this circuit.

    Example: "5629045554450325504"

  • tier_id
    string|null

    The id of the tier contained in this circuit.

    Example: "5629012354450701104"

PATCH /circuits/{circuit_id}/tournaments/{id}

Updates the classification of a tournament in the given circuit.

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_id": "5617559294676615168",
    "region_id": "5629045554450325504",
    "tier_id": "5629012354450701104"
}
Structure (object)
  • season_id
    string|null

    Optional

    The id of the season contained in this circuit.

    Example: "5617559294676615168"

  • region_id
    string|null

    Optional

    The id of the region contained in this circuit.

    Example: "5629045554450325504"

  • tier_id
    string|null

    Optional

    The id of the tier contained in this circuit.

    Example: "5629012354450701104"

Response

[200] Success.

Example
{
    "tournament_id": "5617559294676615168",
    "season_id": "5617559294676615168",
    "region_id": "5629045554450325504",
    "tier_id": "5629012354450701104"
}
Structure (object)
  • tournament_id
    string

    The unique identifier of the tournament.

    Example: "5617559294676615168"

  • season_id
    string|null

    The id of the season contained in this circuit.

    Example: "5617559294676615168"

  • region_id
    string|null

    The id of the region contained in this circuit.

    Example: "5629045554450325504"

  • tier_id
    string|null

    The id of the tier contained in this circuit.

    Example: "5629012354450701104"

DELETE /circuits/{circuit_id}/tournaments/{id}

Removes the identified tournament from a given circuit, with its classification.

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.