Structure API › Rounds
GET /rounds
Returns all rounds with basic information and settings.
Resource URL
https://api.toornament.com/organizer/v2/rounds
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
rounds
unit. The size of the range can not exceed 50. (see Pagination)Example: rounds=0-49
Query Parameters
- stage_idsarray
A list of stage ids to filter.
Example: 618965765764577354,618931468547654563
- stage_numbersarray
A list of stage numbers to filter.
Example: 1,3
- group_idsarray
A list of group ids to filter.
Example: 618965314871946714,618932178746476544
- group_numbersarray
A list of group numbers to filter.
Example: 3,4
- tournament_idsarray
Only return rounds for the given list of tournaments.
Example: 618965416546776434,618975467354349191
Request Body
This endpoint does not require a request body.
Response
[206] Rounds retrieved.
Example
[ { "name": "1\/8th Finals", "settings": { "pairing_values": [] }, "id": "618983668512789184", "number": 2, "match_settings": { "format": { "type": "best_of", "options": { "nb_match_sets": 3 } } }, "stage_id": "618945443132178479", "group_id": "618983668512789184", "tournament_id": "378426939508809728", "closed": false } ]
Structure (collection)
- namestring
The name of the round.
Max. length: 30 characters
Example: "1/8th Finals"
- settingsobject
Settings that describe the various options related to the round and stage types.
Example: {"pairing_values":[]}
- idstring
The id of the round.
Example: "618983668512789184"
- numberinteger
A number used for ordering rounds.
Example: 2
- match_settingsobject
Settings that define the match configuration used in the round.
Example: {"format":{"type":"best_of","options":{"nb_match_sets":3}}}
- stage_idstring
The id of the stage that contains the round.
Example: "618945443132178479"
- group_idstring
The id of the group that contains the round.
Example: "618983668512789184"
- tournament_idstring
The id of the tournament that contains this round.
Example: "378426939508809728"
- closedboolean
Whether the round is closed.
Example: false
GET /rounds/{id}
Returns a round with the given id with basic information and settings.
Resource URL
https://api.toornament.com/organizer/v2/rounds/{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 round.
Query Parameters
This endpoint does not have any query parameters.
Request Body
This endpoint does not require a request body.
Response
[200] Round retrieved.
Example
{ "name": "1\/8th Finals", "settings": { "pairing_values": [] }, "id": "618983668512789184", "number": 2, "match_settings": { "format": { "type": "best_of", "options": { "nb_match_sets": 3 } } }, "stage_id": "618945443132178479", "group_id": "618983668512789184", "tournament_id": "378426939508809728", "closed": false }
Structure (object)
- namestring
The name of the round.
Max. length: 30 characters
Example: "1/8th Finals"
- settingsobject
Settings that describe the various options related to the round and stage types.
Example: {"pairing_values":[]}
- idstring
The id of the round.
Example: "618983668512789184"
- numberinteger
A number used for ordering rounds.
Example: 2
- match_settingsobject
Settings that define the match configuration used in the round.
Example: {"format":{"type":"best_of","options":{"nb_match_sets":3}}}
- stage_idstring
The id of the stage that contains the round.
Example: "618945443132178479"
- group_idstring
The id of the group that contains the round.
Example: "618983668512789184"
- tournament_idstring
The id of the tournament that contains this round.
Example: "378426939508809728"
- closedboolean
Whether the round is closed.
Example: false
LegacyGET /tournaments/{tournament_id}/rounds
This endpoint is in legacy mode. Access will soon be deprecated. It is therefore advised to use another endpoint when possible.
Returns all rounds of a tournament with basic information and settings.
Resource URL
https://api.toornament.com/organizer/v2/tournaments/{tournament_id}/rounds
HTTP headers
- X-Api-Keystring
API key of your application (see Authentication)
- Authorizationstring
Access token with
organizer:result
scope (see Authorization) - Rangestring
A range of requested items using the
rounds
unit. The size of the range can not exceed 50. (see Pagination)Example: rounds=0-49
Path parameters
- tournament_idstring
The id of the tournament you want to retrieve data about.
Query Parameters
- stage_idsarray
A list of stage ids to filter.
Example: 618965765764577354,618931468547654563
- stage_numbersarray
A list of stage numbers to filter.
Example: 1,3
- group_idsarray
A list of group ids to filter.
Example: 618965314871946714,618932178746476544
- group_numbersarray
A list of group numbers to filter.
Example: 3,4
Request Body
This endpoint does not require a request body.
Response
[206] Rounds retrieved.
Example
[ { "name": "1\/8th Finals", "settings": { "pairing_values": [] }, "id": "618983668512789184", "number": 2, "stage_id": "618945443132178479", "group_id": "618983668512789184", "closed": false } ]
Structure (collection)
- namestring
The name of the round.
Max. length: 30 characters
Example: "1/8th Finals"
- settingsobject
Settings that describe the various options related to the round and stage types.
Example: {"pairing_values":[]}
- idstring
The id of the round.
Example: "618983668512789184"
- numberinteger
A number used for ordering rounds.
Example: 2
- stage_idstring
The id of the stage that contains the round.
Example: "618945443132178479"
- group_idstring
The id of the group that contains the round.
Example: "618983668512789184"
- closedboolean
Whether the round is closed.
Example: false
LegacyGET /tournaments/{tournament_id}/rounds/{id}
This endpoint is in legacy mode. Access will soon be deprecated. It is therefore advised to use another endpoint when possible.
Returns a round with the given id with basic information and settings.
Resource URL
https://api.toornament.com/organizer/v2/tournaments/{tournament_id}/rounds/{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 round.
Query Parameters
This endpoint does not have any query parameters.
Request Body
This endpoint does not require a request body.
Response
[200] Round retrieved.
Example
{ "name": "1\/8th Finals", "settings": { "pairing_values": [] }, "id": "618983668512789184", "number": 2, "stage_id": "618945443132178479", "group_id": "618983668512789184", "closed": false }
Structure (object)
- namestring
The name of the round.
Max. length: 30 characters
Example: "1/8th Finals"
- settingsobject
Settings that describe the various options related to the round and stage types.
Example: {"pairing_values":[]}
- idstring
The id of the round.
Example: "618983668512789184"
- numberinteger
A number used for ordering rounds.
Example: 2
- stage_idstring
The id of the stage that contains the round.
Example: "618945443132178479"
- group_idstring
The id of the group that contains the round.
Example: "618983668512789184"
- closedboolean
Whether the round is closed.
Example: false