Circuit API › Circuits
GET /circuits
Returns the circuits contained in your project.
Resource URL
https://api.toornament.com/circuit/v2/circuits
HTTP headers
- X-Api-Keystring
API key of your application (see Authentication)
- Authorizationstring
Access token with
organizer:circuit
scope (see Authorization) - Rangestring
A range of requested items using the
circuits
unit. The size of the range can not exceed 50. (see Pagination)Example: circuits=0-49
Query Parameters
- circuit_idsarray
Only return circuits for the given list of ids.
Example: 5617559294676615168,5629045554450325504
Request Body
This endpoint does not require a request body.
Response
[206] Circuits retrieved.
Example
[ { "id": "5617559294676615168", "name": "My Extreme Masters", "description": "Circuit for the Extreme Masters, the best competition of all.", "logo": { "id": "506637910019156865" } } ]
Structure (collection)
- idstring
The unique identifier of the circuit.
Example: "5617559294676615168"
- namestring
The name of the circuit.
Max. length: 40 characters
Example: "My Extreme Masters"
- descriptionstring|null
Optional
Description of the circuit.
Max. length: 1,500 characters
Example: "Circuit for the Extreme Masters, the best competition of all."
- logoobject|null
Optional
The circuit logo.
POST /circuits
Creates a new circuit.
Resource URL
https://api.toornament.com/circuit/v2/circuits
HTTP headers
- X-Api-Keystring
API key of your application (see Authentication)
- Authorizationstring
Access token with
organizer:circuit
scope (see Authorization)
Query Parameters
This endpoint does not have any query parameters.
Request Body
Circuit data
Example
{ "name": "My Extreme Masters", "description": "Circuit for the Extreme Masters, the best competition of all.", "logo": { "id": "506637910019156865" } }
Structure (object)
- namestring
The name of the circuit.
Max. length: 40 characters
Example: "My Extreme Masters"
- descriptionstring|null
Optional
Description of the circuit.
Max. length: 1,500 characters
Example: "Circuit for the Extreme Masters, the best competition of all."
- logoobject|null
Optional
The circuit logo.
Response
[201] Circuit created.
Example
{ "id": "5617559294676615168", "name": "My Extreme Masters", "description": "Circuit for the Extreme Masters, the best competition of all.", "logo": { "id": "506637910019156865" } }
Structure (object)
- idstring
The unique identifier of the circuit.
Example: "5617559294676615168"
- namestring
The name of the circuit.
Max. length: 40 characters
Example: "My Extreme Masters"
- descriptionstring|null
Optional
Description of the circuit.
Max. length: 1,500 characters
Example: "Circuit for the Extreme Masters, the best competition of all."
- logoobject|null
Optional
The circuit logo.
GET /circuits/{id}
Returns a circuit identified with the given id.
Resource URL
https://api.toornament.com/circuit/v2/circuits/{id}
HTTP headers
- X-Api-Keystring
API key of your application (see Authentication)
- Authorizationstring
Access token with
organizer:circuit
scope (see Authorization)
Path parameters
- 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
[200] Circuit retrieved.
Example
{ "id": "5617559294676615168", "name": "My Extreme Masters", "description": "Circuit for the Extreme Masters, the best competition of all.", "logo": { "id": "506637910019156865" } }
Structure (object)
- idstring
The unique identifier of the circuit.
Example: "5617559294676615168"
- namestring
The name of the circuit.
Max. length: 40 characters
Example: "My Extreme Masters"
- descriptionstring|null
Optional
Description of the circuit.
Max. length: 1,500 characters
Example: "Circuit for the Extreme Masters, the best competition of all."
- logoobject|null
Optional
The circuit logo.
PATCH /circuits/{id}
Updates the name and description of a circuit.
Resource URL
https://api.toornament.com/circuit/v2/circuits/{id}
HTTP headers
- X-Api-Keystring
API key of your application (see Authentication)
- Authorizationstring
Access token with
organizer:circuit
scope (see Authorization)
Path parameters
- idstring
The id of the circuit.
Query Parameters
This endpoint does not have any query parameters.
Request Body
Circuit data.
Example
{ "name": "My Extreme Masters", "description": "Circuit for the Extreme Masters, the best competition of all.", "logo": { "id": "506637910019156865" } }
Structure (object)
- namestring
Optional
The name of the circuit.
Max. length: 40 characters
Example: "My Extreme Masters"
- descriptionstring|null
Optional
Description of the circuit.
Max. length: 1,500 characters
Example: "Circuit for the Extreme Masters, the best competition of all."
- logoobject|null
Optional
The circuit logo.
Response
[200] Success.
Example
{ "id": "5617559294676615168", "name": "My Extreme Masters", "description": "Circuit for the Extreme Masters, the best competition of all.", "logo": { "id": "506637910019156865" } }
Structure (object)
- idstring
The unique identifier of the circuit.
Example: "5617559294676615168"
- namestring
The name of the circuit.
Max. length: 40 characters
Example: "My Extreme Masters"
- descriptionstring|null
Optional
Description of the circuit.
Max. length: 1,500 characters
Example: "Circuit for the Extreme Masters, the best competition of all."
- logoobject|null
Optional
The circuit logo.
DELETE /circuits/{id}
Deletes the circuit identified by the given id.
Resource URL
https://api.toornament.com/circuit/v2/circuits/{id}
HTTP headers
- X-Api-Keystring
API key of your application (see Authentication)
- Authorizationstring
Access token with
organizer:circuit
scope (see Authorization)
Path parameters
- 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.