Stages

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
        }
    }
]

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.

  Possible values: single_elimination, double_elimination, bracket_groups, pools, gauntlet, league, swiss, simple, ffa_single_elimination_ ffa_bracket_groups

• closed

  boolean

  Whether the stage is closed.

  Example: false

• settings

  object

  Settings that describe the various options for the stage type.

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

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 to retrieve.

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
    }
}

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.

  Possible values: single_elimination, double_elimination, bracket_groups, pools, gauntlet, league, swiss, simple, ffa_single_elimination_ ffa_bracket_groups

• closed

  boolean

  Whether the stage is closed.

  Example: false

• settings

  object

  Settings that describe the various options for the stage type.

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

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 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",
        "number": 2,
        "name": "Playoffs",
        "type": "double_elimination",
        "closed": false,
        "settings": {
            "size": 16,
            "grand_final": "simple",
            "threshold": 0,
            "skip_round1": false
        },
        "tournament_id": "378426939508809728"
    }
]

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.

  Possible values: single_elimination, double_elimination, bracket_groups, pools, gauntlet, league, swiss, simple, ffa_single_elimination_ ffa_bracket_groups

• closed

  boolean

  Whether the stage is closed.

  Example: false

• settings

  object

  Settings that describe the various options for the stage type.

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

• tournament_id

  string

  The id of the tournament.

  Example: "378426939508809728"

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 scope (see Authorization)

Path parameters

• id

  string

  The id of the stage to retrieve.

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
        },
        "tournament_id": "378426939508809728"
    }
]

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.

  Possible values: single_elimination, double_elimination, bracket_groups, pools, gauntlet, league, swiss, simple, ffa_single_elimination_ ffa_bracket_groups

• closed

  boolean

  Whether the stage is closed.

  Example: false

• settings

  object

  Settings that describe the various options for the stage type.

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

• tournament_id

  string

  The id of the tournament.

  Example: "378426939508809728"