Structure API › Stages

Download OpenAPI 3.0

Endpoints

GET /stages

Returns all stages of a tournament with basic information and settings.

Resource URL

https://api.toornament.com/organizer/v2/stages

HTTP headers

  • X-Api-Key
    string

    API key of your application (see Authentication)

  • Authorization
    string

    Access token with organizer:result or organizer:admin scope (see Authorization)

  • Range
    string

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

    Example: stages=0-49

Query Parameters

  • tournament_ids
    array

    Only return stages for the given list of tournaments.

    Example: 378426939508809728,534138941862841533

Request Body

This endpoint does not require a request body.

Response

[200] Stages retrieved

Example
[
    {
        "id": "618983668512789184",
        "tournament_id": "378426939508809728",
        "number": 2,
        "name": "Playoffs",
        "type": "double_elimination",
        "status": "pending",
        "closed": false,
        "settings": {
            "size": 16,
            "grand_final": "simple",
            "threshold": 0,
            "skip_round1": false
        },
        "match_settings": {
            "format": {
                "type": "best_of",
                "options": {
                    "nb_match_sets": 3
                }
            }
        },
        "auto_placement_enabled": false
    }
]
Structure (collection)
  • id
    string

    The id of the stage.

    Example: "618983668512789184"

  • tournament_id
    string

    The id of the tournament.

    Example: "378426939508809728"

  • number
    integer

    A number used for ordering stages.

    Example: 2

  • name
    string

    The name of the stage.

    Max. length: 30 characters

    Example: "Playoffs"

  • type
    string

    The type of stage that defines how the stage functions (see Stages).

    Possible values: single_elimination, double_elimination, bracket_groups, custom_bracket, pools, gauntlet, league, swiss, simple, ffa_single_elimination, ffa_bracket_groups, ffa_custom_bracket, ffa_league

  • status
    string

    The status of the stage.

    Possible values: pending, ready, running, completed

  • closed
    boolean

    Whether the stage is closed.

    Example: false

  • settings
    object

    Settings that describe the various options for the stage type (see Stages).

    Example: {"size":16,"grand_final":"simple","threshold":0,"skip_round1":false}

  • match_settings
    object

    Settings that define the match configuration used in the stage.

    Example: {"format":{"type":"best_of","options":{"nb_match_sets":3}}}

  • auto_placement_enabled
    boolean

    If enabled, participants will automatically be placed in the stage using their creation order as seeding.

    Example: false

POST /stages

Creates a new stage.

Resource URL

https://api.toornament.com/organizer/v2/stages

HTTP headers

  • X-Api-Key
    string

    API key of your application (see Authentication)

  • Authorization
    string

    Access token with organizer:admin scope (see Authorization)

Query Parameters

This endpoint does not have any query parameters.

Request Body

Stage data

Example
{
    "tournament_id": "378426939508809728",
    "number": 2,
    "name": "Playoffs",
    "type": "double_elimination",
    "settings": {
        "size": 16,
        "grand_final": "simple",
        "threshold": 0,
        "skip_round1": false
    },
    "match_settings": {
        "format": {
            "type": "best_of",
            "options": {
                "nb_match_sets": 3
            }
        }
    },
    "auto_placement_enabled": false
}
Structure (object)
  • tournament_id
    string

    The id of the tournament.

    Example: "378426939508809728"

  • number
    integer

    A number used for ordering stages.

    Example: 2

  • name
    string

    The name of the stage.

    Max. length: 30 characters

    Example: "Playoffs"

  • type
    string

    The type of stage that defines how the stage functions (see Stages).

    Possible values: single_elimination, double_elimination, bracket_groups, custom_bracket, pools, gauntlet, league, swiss, simple, ffa_single_elimination, ffa_bracket_groups, ffa_custom_bracket, ffa_league

  • settings
    object

    Settings that describe the various options for the stage type (see Stages).

    Example: {"size":16,"grand_final":"simple","threshold":0,"skip_round1":false}

  • match_settings
    object

    Optional

    Settings that define the match configuration used in the stage.

    Example: {"format":{"type":"best_of","options":{"nb_match_sets":3}}}

  • auto_placement_enabled
    boolean

    Optional

    If enabled, participants will automatically be placed in the stage using their creation order as seeding.

    Example: false

Response

[201] Success

Example
{
    "id": "618983668512789184",
    "tournament_id": "378426939508809728",
    "number": 2,
    "name": "Playoffs",
    "type": "double_elimination",
    "status": "pending",
    "closed": false,
    "settings": {
        "size": 16,
        "grand_final": "simple",
        "threshold": 0,
        "skip_round1": false
    },
    "match_settings": {
        "format": {
            "type": "best_of",
            "options": {
                "nb_match_sets": 3
            }
        }
    },
    "auto_placement_enabled": false
}
Structure (object)
  • id
    string

    The id of the stage.

    Example: "618983668512789184"

  • tournament_id
    string

    The id of the tournament.

    Example: "378426939508809728"

  • number
    integer

    A number used for ordering stages.

    Example: 2

  • name
    string

    The name of the stage.

    Max. length: 30 characters

    Example: "Playoffs"

  • type
    string

    The type of stage that defines how the stage functions (see Stages).

    Possible values: single_elimination, double_elimination, bracket_groups, custom_bracket, pools, gauntlet, league, swiss, simple, ffa_single_elimination, ffa_bracket_groups, ffa_custom_bracket, ffa_league

  • status
    string

    The status of the stage.

    Possible values: pending, ready, running, completed

  • closed
    boolean

    Whether the stage is closed.

    Example: false

  • settings
    object

    Settings that describe the various options for the stage type (see Stages).

    Example: {"size":16,"grand_final":"simple","threshold":0,"skip_round1":false}

  • match_settings
    object

    Settings that define the match configuration used in the stage.

    Example: {"format":{"type":"best_of","options":{"nb_match_sets":3}}}

  • auto_placement_enabled
    boolean

    If enabled, participants will automatically be placed in the stage using their creation order as seeding.

    Example: false

GET /stages/{id}

Returns a stage with the given id with basic information and settings.

Resource URL

https://api.toornament.com/organizer/v2/stages/{id}

HTTP headers

  • X-Api-Key
    string

    API key of your application (see Authentication)

  • Authorization
    string

    Access token with organizer:result or organizer:admin scope (see Authorization)

Path parameters

  • id
    string

    The id of the stage.

Query Parameters

This endpoint does not have any query parameters.

Request Body

This endpoint does not require a request body.

Response

[200] Stage retrieved

Example
{
    "id": "618983668512789184",
    "tournament_id": "378426939508809728",
    "number": 2,
    "name": "Playoffs",
    "type": "double_elimination",
    "status": "pending",
    "closed": false,
    "settings": {
        "size": 16,
        "grand_final": "simple",
        "threshold": 0,
        "skip_round1": false
    },
    "match_settings": {
        "format": {
            "type": "best_of",
            "options": {
                "nb_match_sets": 3
            }
        }
    },
    "auto_placement_enabled": false
}
Structure (object)
  • id
    string

    The id of the stage.

    Example: "618983668512789184"

  • tournament_id
    string

    The id of the tournament.

    Example: "378426939508809728"

  • number
    integer

    A number used for ordering stages.

    Example: 2

  • name
    string

    The name of the stage.

    Max. length: 30 characters

    Example: "Playoffs"

  • type
    string

    The type of stage that defines how the stage functions (see Stages).

    Possible values: single_elimination, double_elimination, bracket_groups, custom_bracket, pools, gauntlet, league, swiss, simple, ffa_single_elimination, ffa_bracket_groups, ffa_custom_bracket, ffa_league

  • status
    string

    The status of the stage.

    Possible values: pending, ready, running, completed

  • closed
    boolean

    Whether the stage is closed.

    Example: false

  • settings
    object

    Settings that describe the various options for the stage type (see Stages).

    Example: {"size":16,"grand_final":"simple","threshold":0,"skip_round1":false}

  • match_settings
    object

    Settings that define the match configuration used in the stage.

    Example: {"format":{"type":"best_of","options":{"nb_match_sets":3}}}

  • auto_placement_enabled
    boolean

    If enabled, participants will automatically be placed in the stage using their creation order as seeding.

    Example: false

PATCH /stages/{id}

Updates a single stage.

Resource URL

https://api.toornament.com/organizer/v2/stages/{id}

HTTP headers

  • X-Api-Key
    string

    API key of your application (see Authentication)

  • Authorization
    string

    Access token with organizer:admin scope (see Authorization)

Path parameters

  • id
    string

    The id of the stage.

Query Parameters

This endpoint does not have any query parameters.

Request Body

Stage data

Example
{
    "number": 2,
    "name": "Playoffs",
    "settings": {
        "size": 16,
        "grand_final": "simple",
        "threshold": 0,
        "skip_round1": false
    },
    "match_settings": {
        "format": {
            "type": "best_of",
            "options": {
                "nb_match_sets": 3
            }
        }
    },
    "auto_placement_enabled": false
}
Structure (object)
  • number
    integer

    Optional

    A number used for ordering stages.

    Example: 2

  • name
    string

    Optional

    The name of the stage.

    Max. length: 30 characters

    Example: "Playoffs"

  • settings
    object

    Optional

    Settings that describe the various options for the stage type (see Stages).

    Example: {"size":16,"grand_final":"simple","threshold":0,"skip_round1":false}

  • match_settings
    object

    Optional

    Settings that define the match configuration used in the stage.

    Example: {"format":{"type":"best_of","options":{"nb_match_sets":3}}}

  • auto_placement_enabled
    boolean

    Optional

    If enabled, participants will automatically be placed in the stage using their creation order as seeding.

    Example: false

Response

[200] Success

Example
{
    "id": "618983668512789184",
    "tournament_id": "378426939508809728",
    "number": 2,
    "name": "Playoffs",
    "type": "double_elimination",
    "status": "pending",
    "closed": false,
    "settings": {
        "size": 16,
        "grand_final": "simple",
        "threshold": 0,
        "skip_round1": false
    },
    "match_settings": {
        "format": {
            "type": "best_of",
            "options": {
                "nb_match_sets": 3
            }
        }
    },
    "auto_placement_enabled": false
}
Structure (object)
  • id
    string

    The id of the stage.

    Example: "618983668512789184"

  • tournament_id
    string

    The id of the tournament.

    Example: "378426939508809728"

  • number
    integer

    A number used for ordering stages.

    Example: 2

  • name
    string

    The name of the stage.

    Max. length: 30 characters

    Example: "Playoffs"

  • type
    string

    The type of stage that defines how the stage functions (see Stages).

    Possible values: single_elimination, double_elimination, bracket_groups, custom_bracket, pools, gauntlet, league, swiss, simple, ffa_single_elimination, ffa_bracket_groups, ffa_custom_bracket, ffa_league

  • status
    string

    The status of the stage.

    Possible values: pending, ready, running, completed

  • closed
    boolean

    Whether the stage is closed.

    Example: false

  • settings
    object

    Settings that describe the various options for the stage type (see Stages).

    Example: {"size":16,"grand_final":"simple","threshold":0,"skip_round1":false}

  • match_settings
    object

    Settings that define the match configuration used in the stage.

    Example: {"format":{"type":"best_of","options":{"nb_match_sets":3}}}

  • auto_placement_enabled
    boolean

    If enabled, participants will automatically be placed in the stage using their creation order as seeding.

    Example: false

DELETE /stages/{id}

Deletes a single stage.

Resource URL

https://api.toornament.com/organizer/v2/stages/{id}

HTTP headers

  • X-Api-Key
    string

    API key of your application (see Authentication)

  • Authorization
    string

    Access token with organizer:admin scope (see Authorization)

Path parameters

  • id
    string

    The id of the stage.

Query Parameters

This endpoint does not have any query parameters.

Request Body

This endpoint does not require a request body.

Response

[204] Success

LegacyGET /tournaments/{tournament_id}/stages

This endpoint is in legacy mode. Access will soon be deprecated. It is therefore advised to use another endpoint when possible.

Returns all stages of a tournament with basic information and settings.

Resource URL

https://api.toornament.com/organizer/v2/tournaments/{tournament_id}/stages

HTTP headers

  • X-Api-Key
    string

    API key of your application (see Authentication)

  • Authorization
    string

    Access token with organizer:result scope (see Authorization)

Path parameters

  • tournament_id
    string

    The id of the tournament you want to retrieve data about.

Query Parameters

This endpoint does not have any query parameters.

Request Body

This endpoint does not require a request body.

Response

[200] Stages retrieved

Example
[
    {
        "id": "618983668512789184",
        "number": 2,
        "name": "Playoffs",
        "type": "double_elimination",
        "closed": false,
        "settings": {
            "size": 16,
            "grand_final": "simple",
            "threshold": 0,
            "skip_round1": false
        },
        "status": "pending"
    }
]
Structure (collection)
  • id
    string

    The id of the stage.

    Example: "618983668512789184"

  • number
    integer

    A number used for ordering stages.

    Example: 2

  • name
    string

    The name of the stage.

    Max. length: 30 characters

    Example: "Playoffs"

  • type
    string

    The type of stage that defines how the stage functions (see Stages).

    Possible values: single_elimination, double_elimination, bracket_groups, custom_bracket, pools, gauntlet, league, swiss, simple, ffa_single_elimination, ffa_bracket_groups, ffa_custom_bracket, ffa_league

  • closed
    boolean

    Whether the stage is closed.

    Example: false

  • settings
    object

    Settings that describe the various options for the stage type (see Stages).

    Example: {"size":16,"grand_final":"simple","threshold":0,"skip_round1":false}

  • status
    string

    Optional

    The status of the stage.

    Possible values: pending, ready, running, completed

LegacyGET /tournaments/{tournament_id}/stages/{id}

This endpoint is in legacy mode. Access will soon be deprecated. It is therefore advised to use another endpoint when possible.

Returns a stage with the given id with basic information and settings.

Resource URL

https://api.toornament.com/organizer/v2/tournaments/{tournament_id}/stages/{id}

HTTP headers

  • X-Api-Key
    string

    API key of your application (see Authentication)

  • Authorization
    string

    Access token with organizer:result scope (see Authorization)

Path parameters

  • tournament_id
    string

    The id of the tournament you want to retrieve data about.

  • id
    string

    The id of the stage.

Query Parameters

This endpoint does not have any query parameters.

Request Body

This endpoint does not require a request body.

Response

[200] Stage retrieved.

Example
{
    "id": "618983668512789184",
    "number": 2,
    "name": "Playoffs",
    "type": "double_elimination",
    "closed": false,
    "settings": {
        "size": 16,
        "grand_final": "simple",
        "threshold": 0,
        "skip_round1": false
    },
    "status": "pending"
}
Structure (object)
  • id
    string

    The id of the stage.

    Example: "618983668512789184"

  • number
    integer

    A number used for ordering stages.

    Example: 2

  • name
    string

    The name of the stage.

    Max. length: 30 characters

    Example: "Playoffs"

  • type
    string

    The type of stage that defines how the stage functions (see Stages).

    Possible values: single_elimination, double_elimination, bracket_groups, custom_bracket, pools, gauntlet, league, swiss, simple, ffa_single_elimination, ffa_bracket_groups, ffa_custom_bracket, ffa_league

  • closed
    boolean

    Whether the stage is closed.

    Example: false

  • settings
    object

    Settings that describe the various options for the stage type (see Stages).

    Example: {"size":16,"grand_final":"simple","threshold":0,"skip_round1":false}

  • status
    string

    Optional

    The status of the stage.

    Possible values: pending, ready, running, completed