Circuit API › Tournaments
Endpoints
- GET /circuits/{circuit_id}/tournaments
Retrieve the list of tournaments associated of a circuit.
- POST /circuits/{circuit_id}/tournaments
Create a new classification between circuit and tournament as the organizer.
- GET /circuits/{circuit_id}/tournaments/{id}
Retrieve a single classification between circuit and tournament.
- PATCH /circuits/{circuit_id}/tournaments/{id}
Update one a classification.
- DELETE /circuits/{circuit_id}/tournaments/{id}
Delete one of your classifications.
GET /circuits/{circuit_id}/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-Keystring
API key of your application (see Authentication)
- Authorizationstring
Access token with
organizer:circuit
scope (see Authorization)
Path parameters
- circuit_idstring
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)
- seasonstring|null
The machine name of the season.
Example: "open_winter_2022"
- regionstring|null
The machine name of the region.
Example: "europe"
- tierstring|null
The machine name of the tier.
Example: "tier_1"
- tournament_idstring
The unique identifier of the tournament.
Example: "5617559294676615168"
POST /circuits/{circuit_id}/tournaments
Create a new classification between circuit and tournament.
Resource URL
https://api.toornament.com/circuit/v2/circuits/{circuit_id}/tournaments
HTTP headers
- X-Api-Keystring
API key of your application (see Authentication)
- Authorizationstring
Access token with
organizer:circuit
scope (see Authorization)
Path parameters
- circuit_idstring
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)
- seasonstring|null
Optional
The machine name of the season.
Example: "open_winter_2022"
- regionstring|null
Optional
The machine name of the region.
Example: "europe"
- tierstring|null
Optional
The machine name of the tier.
Example: "tier_1"
- tournament_idstring
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)
- seasonstring|null
The machine name of the season.
Example: "open_winter_2022"
- regionstring|null
The machine name of the region.
Example: "europe"
- tierstring|null
The machine name of the tier.
Example: "tier_1"
- tournament_idstring
The unique identifier of the tournament.
Example: "5617559294676615168"
GET /circuits/{circuit_id}/tournaments/{id}
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-Keystring
API key of your application (see Authentication)
- Authorizationstring
Access token with
organizer:circuit
scope (see Authorization)
Path parameters
- circuit_idstring
The id of the circuit.
- idstring
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)
- seasonstring|null
The machine name of the season.
Example: "open_winter_2022"
- regionstring|null
The machine name of the region.
Example: "europe"
- tierstring|null
The machine name of the tier.
Example: "tier_1"
- tournament_idstring
The unique identifier of the tournament.
Example: "5617559294676615168"
PATCH /circuits/{circuit_id}/tournaments/{id}
Updates classifications.
Resource URL
https://api.toornament.com/circuit/v2/circuits/{circuit_id}/tournaments/{id}
HTTP headers
- X-Api-Keystring
API key of your application (see Authentication)
- Authorizationstring
Access token with
organizer:circuit
scope (see Authorization)
Path parameters
- circuit_idstring
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)
- seasonstring|null
Optional
The machine name of the season.
Example: "open_winter_2022"
- regionstring|null
Optional
The machine name of the region.
Example: "europe"
- tierstring|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)
- seasonstring|null
The machine name of the season.
Example: "open_winter_2022"
- regionstring|null
The machine name of the region.
Example: "europe"
- tierstring|null
The machine name of the tier.
Example: "tier_1"
- tournament_idstring
The unique identifier of the tournament.
Example: "5617559294676615168"
DELETE /circuits/{circuit_id}/tournaments/{id}
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-Keystring
API key of your application (see Authentication)
- Authorizationstring
Access token with
organizer:circuit
scope (see Authorization)
Path parameters
- circuit_idstring
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.