Circuit API › Circuits

GET /circuits

Returns circuits you organize with all organizer-specific data.

Resource URL

https://api.toornament.com/circuit/v2/circuits

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 circuits unit. The size of the range can not exceed 50. (see Pagination)

    Example: circuits=0-49

Query Parameters

  • circuit_ids
    array

    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
[
    {
        "name": "My Extreme Masters",
        "id": "5617559294676615168"
    }
]
Structure (collection)
  • name
    string

    The name of the circuit.

    Max. length: 40 characters

    Example: "My Extreme Masters"

  • id
    string

    The unique identifier of the circuit.

    Example: "5617559294676615168"

POST /circuits

Creates a new circuit.

Resource URL

https://api.toornament.com/circuit/v2/circuits

HTTP headers

  • X-Api-Key
    string

    API key of your application (see Authentication)

  • Authorization
    string

    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"
}
Structure (object)
  • name
    string

    The name of the circuit.

    Max. length: 40 characters

    Example: "My Extreme Masters"

Response

[201] Circuit created.

Example
{
    "name": "My Extreme Masters",
    "id": "5617559294676615168"
}
Structure (object)
  • name
    string

    The name of the circuit.

    Max. length: 40 characters

    Example: "My Extreme Masters"

  • id
    string

    The unique identifier of the circuit.

    Example: "5617559294676615168"

GET /circuits/{id}

Returns a circuit identified with the given id with all organizer-specific data.

Resource URL

https://api.toornament.com/circuit/v2/circuits/{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

  • 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

[200] Circuit retrieved.

Example
{
    "name": "My Extreme Masters",
    "id": "5617559294676615168"
}
Structure (object)
  • name
    string

    The name of the circuit.

    Max. length: 40 characters

    Example: "My Extreme Masters"

  • id
    string

    The unique identifier of the circuit.

    Example: "5617559294676615168"

PATCH /circuits/{id}

Updates one or several fields of one of your circuits.

Resource URL

https://api.toornament.com/circuit/v2/circuits/{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

  • id
    string

    The id of the circuit.

Query Parameters

This endpoint does not have any query parameters.

Request Body

Circuit data.

Example
{
    "name": "My Extreme Masters"
}
Structure (object)
  • name
    string

    Optional

    The name of the circuit.

    Max. length: 40 characters

    Example: "My Extreme Masters"

Response

[200] Success.

Example
{
    "name": "My Extreme Masters",
    "id": "5617559294676615168"
}
Structure (object)
  • name
    string

    The name of the circuit.

    Max. length: 40 characters

    Example: "My Extreme Masters"

  • id
    string

    The unique identifier of the circuit.

    Example: "5617559294676615168"

DELETE /circuits/{id}

Deletes your circuit identified by the given id.

Resource URL

https://api.toornament.com/circuit/v2/circuits/{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

  • 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.