Circuit API › Circuits

Returns the circuits contained in your project.

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

[
    {
        "id": "5617559294676615168",
        "name": "My Extreme Masters",
        "public": true,
        "description": "Circuit for the Extreme Masters, the best competition of all.",
        "logo": {
            "id": "506637910019156865"
        },
        "background": {
            "id": "765410519970259039"
        },
        "tagline": "My tagline Circuit",
        "organization": "My organization",
        "contact": "[email protected]",
        "discord": "https:\/\/discord.com\/",
        "website": "https:\/\/tournament.com"
    }
]

Structure (collection)

• id

  string

  The unique identifier of the circuit.

  Example: "5617559294676615168"

• name

  string

  The name of the circuit.

  Max. length: 40 characters

  Example: "My Extreme Masters"

• public

  boolean

  Whether the circuit is published or not.

  Example: true

• description

  string|null

  Description of the circuit.

  Max. length: 4,000 characters

  Example: "Circuit for the Extreme Masters, the best competition of all."

• logo

  object|null

  The circuit logo.

  • id

    string

    The unique identifier of a file (with context "circuit_logo"), that can be used in other APIs.

    Example: "506637910019156865"

• background

  object|null

  The circuit background.

  • id

    string

    The unique identifier of a file (with context "circuit_background"), that can be used in other APIs.

    Example: "765410519970259039"

• tagline

  string

  The tagline of the circuit.

  Max. length: 255 characters

  Example: "My tagline Circuit"

• organization

  string

  The organization of the circuit.

  Max. length: 100 characters

  Example: "My organization"

• contact

  string

  The contact of the circuit.

  Max. length: 255 characters

  Example: "[email protected]"

• discord

  string

  The discord of the circuit.

  Max. length: 255 characters

  Example: "https://discord.com/"

• website

  string

  The website of the circuit.

  Max. length: 255 characters

  Example: "https://tournament.com"

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",
    "public": true,
    "description": "Circuit for the Extreme Masters, the best competition of all.",
    "logo": {
        "id": "506637910019156865"
    },
    "background": {
        "id": "765410519970259039"
    },
    "tagline": "My tagline Circuit",
    "organization": "My organization",
    "contact": "[email protected]",
    "discord": "https:\/\/discord.com\/",
    "website": "https:\/\/tournament.com"
}

Structure (object)

• name

  string

  The name of the circuit.

  Max. length: 40 characters

  Example: "My Extreme Masters"

• public

  boolean

  Optional

  Whether the circuit is published or not.

  Example: true

• description

  string|null

  Optional

  Description of the circuit.

  Max. length: 4,000 characters

  Example: "Circuit for the Extreme Masters, the best competition of all."

• logo

  object|null

  Optional

  The circuit logo.

  • id

    string

    The unique identifier of a file (with context "circuit_logo"), that can be used in other APIs.

    Example: "506637910019156865"

• background

  object|null

  Optional

  The circuit background.

  • id

    string

    The unique identifier of a file (with context "circuit_background"), that can be used in other APIs.

    Example: "765410519970259039"

• tagline

  string

  Optional

  The tagline of the circuit.

  Max. length: 255 characters

  Example: "My tagline Circuit"

• organization

  string

  Optional

  The organization of the circuit.

  Max. length: 100 characters

  Example: "My organization"

• contact

  string

  Optional

  The contact of the circuit.

  Max. length: 255 characters

  Example: "[email protected]"

• discord

  string

  Optional

  The discord of the circuit.

  Max. length: 255 characters

  Example: "https://discord.com/"

• website

  string

  Optional

  The website of the circuit.

  Max. length: 255 characters

  Example: "https://tournament.com"

Response

[201] Circuit created.

Example

{
    "id": "5617559294676615168",
    "name": "My Extreme Masters",
    "public": true,
    "description": "Circuit for the Extreme Masters, the best competition of all.",
    "logo": {
        "id": "506637910019156865"
    },
    "background": {
        "id": "765410519970259039"
    },
    "tagline": "My tagline Circuit",
    "organization": "My organization",
    "contact": "[email protected]",
    "discord": "https:\/\/discord.com\/",
    "website": "https:\/\/tournament.com"
}

Structure (object)

• id

  string

  The unique identifier of the circuit.

  Example: "5617559294676615168"

• name

  string

  The name of the circuit.

  Max. length: 40 characters

  Example: "My Extreme Masters"

• public

  boolean

  Whether the circuit is published or not.

  Example: true

• description

  string|null

  Description of the circuit.

  Max. length: 4,000 characters

  Example: "Circuit for the Extreme Masters, the best competition of all."

• logo

  object|null

  The circuit logo.

  • id

    string

    The unique identifier of a file (with context "circuit_logo"), that can be used in other APIs.

    Example: "506637910019156865"

• background

  object|null

  The circuit background.

  • id

    string

    The unique identifier of a file (with context "circuit_background"), that can be used in other APIs.

    Example: "765410519970259039"

• tagline

  string

  The tagline of the circuit.

  Max. length: 255 characters

  Example: "My tagline Circuit"

• organization

  string

  The organization of the circuit.

  Max. length: 100 characters

  Example: "My organization"

• contact

  string

  The contact of the circuit.

  Max. length: 255 characters

  Example: "[email protected]"

• discord

  string

  The discord of the circuit.

  Max. length: 255 characters

  Example: "https://discord.com/"

• website

  string

  The website of the circuit.

  Max. length: 255 characters

  Example: "https://tournament.com"

Returns a circuit identified with 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

[200] Circuit retrieved.

Example

{
    "id": "5617559294676615168",
    "name": "My Extreme Masters",
    "public": true,
    "description": "Circuit for the Extreme Masters, the best competition of all.",
    "logo": {
        "id": "506637910019156865"
    },
    "background": {
        "id": "765410519970259039"
    },
    "tagline": "My tagline Circuit",
    "organization": "My organization",
    "contact": "[email protected]",
    "discord": "https:\/\/discord.com\/",
    "website": "https:\/\/tournament.com"
}

Structure (object)

• id

  string

  The unique identifier of the circuit.

  Example: "5617559294676615168"

• name

  string

  The name of the circuit.

  Max. length: 40 characters

  Example: "My Extreme Masters"

• public

  boolean

  Whether the circuit is published or not.

  Example: true

• description

  string|null

  Description of the circuit.

  Max. length: 4,000 characters

  Example: "Circuit for the Extreme Masters, the best competition of all."

• logo

  object|null

  The circuit logo.

  • id

    string

    The unique identifier of a file (with context "circuit_logo"), that can be used in other APIs.

    Example: "506637910019156865"

• background

  object|null

  The circuit background.

  • id

    string

    The unique identifier of a file (with context "circuit_background"), that can be used in other APIs.

    Example: "765410519970259039"

• tagline

  string

  The tagline of the circuit.

  Max. length: 255 characters

  Example: "My tagline Circuit"

• organization

  string

  The organization of the circuit.

  Max. length: 100 characters

  Example: "My organization"

• contact

  string

  The contact of the circuit.

  Max. length: 255 characters

  Example: "[email protected]"

• discord

  string

  The discord of the circuit.

  Max. length: 255 characters

  Example: "https://discord.com/"

• website

  string

  The website of the circuit.

  Max. length: 255 characters

  Example: "https://tournament.com"

Updates the name and description of a circuit.

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",
    "public": true,
    "description": "Circuit for the Extreme Masters, the best competition of all.",
    "logo": {
        "id": "506637910019156865"
    },
    "background": {
        "id": "765410519970259039"
    },
    "tagline": "My tagline Circuit",
    "organization": "My organization",
    "contact": "[email protected]",
    "discord": "https:\/\/discord.com\/",
    "website": "https:\/\/tournament.com"
}

Structure (object)

• name

  string

  Optional

  The name of the circuit.

  Max. length: 40 characters

  Example: "My Extreme Masters"

• public

  boolean

  Optional

  Whether the circuit is published or not.

  Example: true

• description

  string|null

  Optional

  Description of the circuit.

  Max. length: 4,000 characters

  Example: "Circuit for the Extreme Masters, the best competition of all."

• logo

  object|null

  Optional

  The circuit logo.

  • id

    string

    The unique identifier of a file (with context "circuit_logo"), that can be used in other APIs.

    Example: "506637910019156865"

• background

  object|null

  Optional

  The circuit background.

  • id

    string

    The unique identifier of a file (with context "circuit_background"), that can be used in other APIs.

    Example: "765410519970259039"

• tagline

  string

  Optional

  The tagline of the circuit.

  Max. length: 255 characters

  Example: "My tagline Circuit"

• organization

  string

  Optional

  The organization of the circuit.

  Max. length: 100 characters

  Example: "My organization"

• contact

  string

  Optional

  The contact of the circuit.

  Max. length: 255 characters

  Example: "[email protected]"

• discord

  string

  Optional

  The discord of the circuit.

  Max. length: 255 characters

  Example: "https://discord.com/"

• website

  string

  Optional

  The website of the circuit.

  Max. length: 255 characters

  Example: "https://tournament.com"

Response

[200] Success.

Example

{
    "id": "5617559294676615168",
    "name": "My Extreme Masters",
    "public": true,
    "description": "Circuit for the Extreme Masters, the best competition of all.",
    "logo": {
        "id": "506637910019156865"
    },
    "background": {
        "id": "765410519970259039"
    },
    "tagline": "My tagline Circuit",
    "organization": "My organization",
    "contact": "[email protected]",
    "discord": "https:\/\/discord.com\/",
    "website": "https:\/\/tournament.com"
}

Structure (object)

• id

  string

  The unique identifier of the circuit.

  Example: "5617559294676615168"

• name

  string

  The name of the circuit.

  Max. length: 40 characters

  Example: "My Extreme Masters"

• public

  boolean

  Whether the circuit is published or not.

  Example: true

• description

  string|null

  Description of the circuit.

  Max. length: 4,000 characters

  Example: "Circuit for the Extreme Masters, the best competition of all."

• logo

  object|null

  The circuit logo.

  • id

    string

    The unique identifier of a file (with context "circuit_logo"), that can be used in other APIs.

    Example: "506637910019156865"

• background

  object|null

  The circuit background.

  • id

    string

    The unique identifier of a file (with context "circuit_background"), that can be used in other APIs.

    Example: "765410519970259039"

• tagline

  string

  The tagline of the circuit.

  Max. length: 255 characters

  Example: "My tagline Circuit"

• organization

  string

  The organization of the circuit.

  Max. length: 100 characters

  Example: "My organization"

• contact

  string

  The contact of the circuit.

  Max. length: 255 characters

  Example: "[email protected]"

• discord

  string

  The discord of the circuit.

  Max. length: 255 characters

  Example: "https://discord.com/"

• website

  string

  The website of the circuit.

  Max. length: 255 characters

  Example: "https://tournament.com"

Deletes the 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.