Groups

GET /tournaments/{tournament_id}/groups

Simple Access

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

Resource URL

https://api.toornament.com/viewer/v2/tournaments/{tournament_id}/groups

HTTP headers

  • X-Api-Key
    string

    API key of your application (see Authentication)

  • Range
    string

    A range of requested items using the groups unit. The size of the range cannot exceed 50. (see Pagination)

    Example: groups=0-49

Path parameters

  • tournament_id
    string

    The id of the tournament for which groups must be retrieved

Query Parameters

  • stage_ids
    array

    A list of stage ids to filter

    Example: 618965765764577354,618931468547654563

  • stage_numbers
    array

    A list of stage numbers to filter

    Example: 1,3

Request Body

This endpoint doesn't require a request body.

Response

[206] Groups retrieved

Example
[
    {
        "id": "618983668512789184",
        "stage_id": "618983668512789184",
        "number": 2,
        "name": "Group B",
        "closed": false,
        "settings": {
            "size": 4
        }
    }
]
Structure (collection)
  • id
    string

    The id of the group

    Example: "618983668512789184"

  • stage_id
    string

    The id of the stage that contains the group

    Example: "618983668512789184"

  • number
    integer

    A number used for ordering groups

    Example: 2

  • name
    string

    The name of the group (maximum 30 characters)

    Example: "Group B"

  • closed
    boolean

    Whether the group is closed

    Example: false

  • settings
    object

    Settings that describes various options related to the group and stage type

    Example: {"size":4}

GET /tournaments/{tournament_id}/groups/{id}

Simple Access

Returns a group by the given id with basic information and settings.

Resource URL

https://api.toornament.com/viewer/v2/tournaments/{tournament_id}/groups/{id}

HTTP headers

Path parameters

  • tournament_id
    string

    The id of the tournament that contains the group

  • id
    string

    The id of the group to retrieve

Query Parameters

This endpoint doesn't have any query parameters.

Request Body

This endpoint doesn't require a request body.

Response

[200] Group retrieved

Example
{
    "id": "618983668512789184",
    "stage_id": "618983668512789184",
    "number": 2,
    "name": "Group B",
    "closed": false,
    "settings": {
        "size": 4
    }
}
Structure (object)
  • id
    string

    The id of the group

    Example: "618983668512789184"

  • stage_id
    string

    The id of the stage that contains the group

    Example: "618983668512789184"

  • number
    integer

    A number used for ordering groups

    Example: 2

  • name
    string

    The name of the group (maximum 30 characters)

    Example: "Group B"

  • closed
    boolean

    Whether the group is closed

    Example: false

  • settings
    object

    Settings that describes various options related to the group and stage type

    Example: {"size":4}