Stages | Viewer API | API v2.0 | Toornament Developer

Endpoints

LegacyGET /tournaments/{tournament_id}/stages
Retrieve all stages of a tournament.
LegacyGET /tournaments/{tournament_id}/stages/{id}
Retrieve a single stage of a tournament.

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/viewer/v2/tournaments/{tournament_id}/stages

HTTP headers

X-Api-Key
string
API key of your application (see Authentication)

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}

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