Tournament API › Disciplines

Returns a collection of disciplines.

Resource URL

https://api.toornament.com/organizer/v2/disciplines

HTTP headers

• X-Api-Key

  string

  API key of your application (see Authentication)

• Range

  string

  A range of requested items using the disciplines unit. The size of the range can not exceed 50. (see Pagination)

  Example: disciplines=0-49

Query Parameters

This endpoint does not have any query parameters.

Request Body

This endpoint does not require a request body.

Response

[206] Disciplines retrieved.

Example

[
    {
        "id": "counterstrike_go",
        "name": "Counter-Strike: GO",
        "shortname": "CS:GO",
        "fullname": "Counter-Strike: Global Offensive",
        "copyrights": "Valve Software"
    }
]

Structure (collection)

• id

  string

  An identifier for a discipline, can be used in others APIs.

  Example: "counterstrike_go"

• name

  string

  The official name of the discipline.

  Example: "Counter-Strike: GO"

• shortname

  string

  The short name of the discipline.

  Example: "CS:GO"

• fullname

  string

  The complete name of the discipline.

  Example: "Counter-Strike: Global Offensive"

• copyrights

  string

  Name of the entity or entities that are the creators and/or right holders of the discipline.

  Example: "Valve Software"

Returns a discipline with its information and configuration options.

Resource URL

https://api.toornament.com/organizer/v2/disciplines/{id}

HTTP headers

• X-Api-Key

  string

  API key of your application (see Authentication)

Path parameters

• id

  string

  The id of the discipline.

Query Parameters

This endpoint does not have any query parameters.

Request Body

This endpoint does not require a request body.

Response

[200] Discipline retrieved.

Example

{
    "platforms_available": [
        "pc",
        "nintendo_switch",
        "neo_geo"
    ],
    "team_size": {
        "min": 4,
        "max": 4
    },
    "features": [
        {
            "name": "track",
            "type": "map",
            "options": {}
        }
    ],
    "id": "counterstrike_go",
    "name": "Counter-Strike: GO",
    "shortname": "CS:GO",
    "fullname": "Counter-Strike: Global Offensive",
    "copyrights": "Valve Software"
}

Structure (object)

• platforms_available

  array[string]

  A list of platforms available of this discipline.

  Possible values: pc, playstation4, xbox_one, nintendo_switch, nintendo_switch2, mobile, playstation3, playstation2, playstation1, ps_vita, psp, xbox360, xbox, wii_u, wii, gamecube, nintendo64, snes, nes, dreamcast, saturn, megadrive, master_system, 3ds, ds, game_boy, neo_geo, other_platform, not_video_game

• team_size

  object

  Sets the minimum and maximum of players in a team.

  • min

    integer

    Minimal size of a team in the tournament.

    Example: 4

  • max

    integer

    Maximal size of a team in the tournament.

    Example: 4

• features

  array[object]

  List of features for the discipline.

  • name

    string

    Name of the feature.

    Example: "track"

  • type

    string

    Type of the feature.

    Example: "map"

  • options

    object

    Options of the feature.

    Example: {}

• id

  string

  An identifier for a discipline, can be used in others APIs.

  Example: "counterstrike_go"

• name

  string

  The official name of the discipline.

  Example: "Counter-Strike: GO"

• shortname

  string

  The short name of the discipline.

  Example: "CS:GO"

• fullname

  string

  The complete name of the discipline.

  Example: "Counter-Strike: Global Offensive"

• copyrights

  string

  Name of the entity or entities that are the creators and/or right holders of the discipline.

  Example: "Valve Software"