Structure API › Stages
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-Keystring
API key of your application (see Authentication)
- Authorizationstring
Access token with
organizer:result
ororganizer:admin
scope (see Authorization) - Rangestring
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_idsarray
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
[ { "number": 2, "name": "Playoffs", "settings": { "size": 16, "grand_final": "simple", "threshold": 0, "skip_round1": false }, "type": "double_elimination", "match_settings": { "format": { "type": "best_of", "options": { "nb_match_sets": 3 } } }, "auto_placement_enabled": false, "tournament_id": "378426939508809728", "id": "618983668512789184", "closed": false } ]
Structure (collection)
- numberinteger
A number used for ordering stages.
Example: 2
- namestring
The name of the stage.
Max. length: 30 characters
Example: "Playoffs"
- settingsobject
Settings that describe the various options for the stage type.
Example: {"size":16,"grand_final":"simple","threshold":0,"skip_round1":false}
- typestring
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
- match_settingsobject
Settings that define the match configuration used in the stage.
Example: {"format":{"type":"best_of","options":{"nb_match_sets":3}}}
- auto_placement_enabledboolean
If enabled, participants will automatically be placed in the stage using their creation order as seeding.
Example: false
- tournament_idstring
The id of the tournament.
Example: "378426939508809728"
- idstring
The id of the stage.
Example: "618983668512789184"
- closedboolean
Whether the stage is closed.
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-Keystring
API key of your application (see Authentication)
- Authorizationstring
Access token with
organizer:result
ororganizer:admin
scope (see Authorization)
Path parameters
- idstring
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
{ "number": 2, "name": "Playoffs", "settings": { "size": 16, "grand_final": "simple", "threshold": 0, "skip_round1": false }, "type": "double_elimination", "match_settings": { "format": { "type": "best_of", "options": { "nb_match_sets": 3 } } }, "auto_placement_enabled": false, "tournament_id": "378426939508809728", "id": "618983668512789184", "closed": false }
Structure (object)
- numberinteger
A number used for ordering stages.
Example: 2
- namestring
The name of the stage.
Max. length: 30 characters
Example: "Playoffs"
- settingsobject
Settings that describe the various options for the stage type.
Example: {"size":16,"grand_final":"simple","threshold":0,"skip_round1":false}
- typestring
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
- match_settingsobject
Settings that define the match configuration used in the stage.
Example: {"format":{"type":"best_of","options":{"nb_match_sets":3}}}
- auto_placement_enabledboolean
If enabled, participants will automatically be placed in the stage using their creation order as seeding.
Example: false
- tournament_idstring
The id of the tournament.
Example: "378426939508809728"
- idstring
The id of the stage.
Example: "618983668512789184"
- closedboolean
Whether the stage is closed.
Example: false
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-Keystring
API key of your application (see Authentication)
- Authorizationstring
Access token with
organizer:result
scope (see Authorization)
Path parameters
- tournament_idstring
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
[ { "number": 2, "name": "Playoffs", "settings": { "size": 16, "grand_final": "simple", "threshold": 0, "skip_round1": false }, "type": "double_elimination", "id": "618983668512789184", "closed": false } ]
Structure (collection)
- numberinteger
A number used for ordering stages.
Example: 2
- namestring
The name of the stage.
Max. length: 30 characters
Example: "Playoffs"
- settingsobject
Settings that describe the various options for the stage type.
Example: {"size":16,"grand_final":"simple","threshold":0,"skip_round1":false}
- typestring
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
- idstring
The id of the stage.
Example: "618983668512789184"
- closedboolean
Whether the stage is closed.
Example: false
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-Keystring
API key of your application (see Authentication)
- Authorizationstring
Access token with
organizer:result
scope (see Authorization)
Path parameters
- tournament_idstring
The id of the tournament you want to retrieve data about.
- idstring
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
{ "number": 2, "name": "Playoffs", "settings": { "size": 16, "grand_final": "simple", "threshold": 0, "skip_round1": false }, "type": "double_elimination", "id": "618983668512789184", "closed": false }
Structure (object)
- numberinteger
A number used for ordering stages.
Example: 2
- namestring
The name of the stage.
Max. length: 30 characters
Example: "Playoffs"
- settingsobject
Settings that describe the various options for the stage type.
Example: {"size":16,"grand_final":"simple","threshold":0,"skip_round1":false}
- typestring
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
- idstring
The id of the stage.
Example: "618983668512789184"
- closedboolean
Whether the stage is closed.
Example: false