Tournament API › Tournaments

Endpoints

GET /tournaments
Retrieve the tournaments you organize and have organized.
POST /tournaments
Create a new tournament as the organizer.
GET /tournaments/{id}
Retrieve a single tournament you organize.
PATCH /tournaments/{id}
Update one of your tournaments.
DELETE /tournaments/{id}
Delete one of your tournaments.

GET /tournaments

Returns tournaments you organize with all organizer-specific data.

Resource URL

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

HTTP headers

X-Api-Key
string
API key of your application (see Authentication)
Authorization
string
Access token with organizer:view scope (see Authorization)
Range
string
A range of requested items using the tournaments unit. The size of the range can not exceed 50. (see Pagination)
Example: tournaments=0-49

Query Parameters

disciplines
string
One or several disciplines to filter.
Example: counterstrike_go,fifa17
statuses
string
One or several tournament statuses to filter.
Possible values: pending, running, completed
Example: pending,running
scheduled_before
string
An ISO 8601 date (only the date part, with YYYY-MM-DD pattern) to include all tournaments scheduled to take place before or at the date.
Format: date
scheduled_after
string
An ISO 8601 date (only the date part, with YYYY-MM-DD pattern) to include all tournaments scheduled to take place after or at the date.
Format: date
countries
string
One or several countries to filter, with format ISO 3166-1 alpha-2 country codes.
Example: US,CA
platforms
string
One or several platforms to filter.
Possible values: pc, playstation4, playstation5, xbox_one, xbox_series, nintendo_switch, nintendo_switch2, mobile, playstation3, xbox360, playstation2, playstation1, ps_vita, psp, xbox, wii_u, wii, gamecube, nintendo64, snes, nes, 3ds, ds, game_boy, dreamcast, saturn, megadrive, master_system, neo_geo, tabletop, other_platform, not_video_game
Example: pc,xbox_one,playstation4
is_online
integer
Whether the tournament is played online.
Possible values: 0, 1
archived
integer
Whether to include archived tournaments.
Possible values: 0, 1
user_ids
array
One or several player user ids involved in the tournaments to filter.
Example: 475141143408399456,735147043408391234
team_ids
array
One or several team ids involved in the tournaments to filter.
Example: 561714159547269773,255149043401714321
custom_user_identifiers
array
One or several custom user identifiers involved in the tournaments to filter.
Example: acme:account:1234
tournament_ids
array
Only return tournaments for the given list of ids.
Example: 378426939508809728,534138941862841533
circuit_ids
array
Only return circuits for the given list of circuit ids.
Example: 5617559294676615168,5629045554450325504
circuit_season_ids
array
Only return tournaments for the given list of season ids.
Example: 5617559294676615168,5629045554450325504
circuit_season_names
array
One or several machine name of seasons to filter.
Example: season_1,season_3
circuit_region_ids
array
Only return tournaments for the given list of region ids.
Example: 5617559294676615168,5629045554450325504
circuit_region_names
array
One or several machine name of regions to filter.
Example: europe,americas,asia
circuit_tier_ids
array
Only return tournaments for the given list of tier ids.
Example: 5617559294676615168,5629045554450325504
circuit_tier_names
array
One or several machine name of tiers to filter.
Example: tier_1,tier_2
sort
string
Sorts the collection in a particular order. "scheduled_asc" sorts the tournaments by scheduled date from the oldest to the most recent one; "scheduled_desc" sorts the tournaments by scheduled date from the most recent to the oldest one.
Possible values: scheduled_asc, scheduled_desc
Default: scheduled_asc

Request Body

This endpoint does not require a request body.

Response

[206] Tournaments retrieved.

Example

[
    {
        "id": "378426939508809728",
        "discipline": "my_discipline",
        "name": "My Weekly Tournament",
        "full_name": "My Weekly Tournament - Long title",
        "status": "running",
        "scheduled_date_start": "2015-09-06",
        "scheduled_date_end": "2015-09-07",
        "timezone": "America\/Sao_Paulo",
        "public": true,
        "size": 16,
        "online": true,
        "location": "London",
        "country": "GB",
        "platforms": [
            "pc"
        ],
        "logo": {
            "id": "7074908991469559808",
            "logo_small": "https:\/\/api.toornament.com\/toornament\/media\/file\/7074908991469559808\/logo_small",
            "logo_medium": "https:\/\/api.toornament.com\/toornament\/media\/file\/7074908991469559808\/logo_medium",
            "logo_large": "https:\/\/api.toornament.com\/toornament\/media\/file\/7074908991469559808\/logo_large",
            "original": "https:\/\/api.toornament.com\/toornament\/media\/file\/7074908991469559808\/original"
        },
        "registration_enabled": true,
        "registration_opening_datetime": "1999-01-01T00:00:00+00:00",
        "registration_closing_datetime": "1999-01-01T00:00:00+00:00"
    }
]

Structure (collection)

id
string
The unique identifier of the tournament.
Example: "378426939508809728"
discipline
string
A unique identifier of the tournament’s discipline.
Example: "my_discipline"
name
string
The name of the tournament.
Max. length: 30 characters
Example: "My Weekly Tournament"
full_name
string|null
The complete name of the tournament.
Max. length: 80 characters
Example: "My Weekly Tournament - Long title"
status
string
The status of the tournament.
Possible values: pending, running, completed
scheduled_date_start
string|null
A starting date in ISO 8601 format (only the date part, with YYYY-MM-DD pattern).
Format: date
Example: "2015-09-06"
scheduled_date_end
string|null
An ending date in ISO 8601 format (only the date part, with YYYY-MM-DD pattern).
Format: date
Example: "2015-09-07"
timezone
string
A time zone from the IANA tz database. For more information, please read the Time Zones documentation.
Example: "America/Sao_Paulo"
public
boolean
Whether the tournament is published or not.
Example: true
size
integer
The expected number of participants in the tournament.
Example: 16
online
boolean|null
Whether the tournament is played on internet or not.
Example: true
location
string|null
The region, city, address or place of interest where the tournament is held.
Max. length: 140 characters
Example: "London"
country
string|null
The country where the tournament is played. Some codes may not be supported. (format is ISO 3166-1 alpha-2)
Example: "GB"
platforms
array[string]
The platform on which the tournament will be played.
Possible values: pc, playstation4, playstation5, xbox_one, xbox_series, nintendo_switch, nintendo_switch2, mobile, playstation3, xbox360, playstation2, playstation1, ps_vita, psp, xbox, wii_u, wii, gamecube, nintendo64, snes, nes, 3ds, ds, game_boy, dreamcast, saturn, megadrive, master_system, neo_geo, tabletop, other_platform, not_video_game
logo
object|null
The tournament logo in every available format.
- id
  string
  The unique identifier of a file (with context "tournament_logo"), that can be used in other APIs.
  Example: "7074908991469559808"
- logo_small
  string
  URL of the small version of the tournament logo.
  Example: "https://api.toornament.com/toornament/media/file/7074908991469559808/logo_small"
- logo_medium
  string
  URL of the medium version of the tournament logo.
  Example: "https://api.toornament.com/toornament/media/file/7074908991469559808/logo_medium"
- logo_large
  string
  URL of the large version of the tournament logo.
  Example: "https://api.toornament.com/toornament/media/file/7074908991469559808/logo_large"
- original
  string
  URL of the original version of the tournament logo.
  Example: "https://api.toornament.com/toornament/media/file/7074908991469559808/original"
registration_enabled
boolean
Whether the registration process is enabled.
Example: true
registration_opening_datetime
string|null
The opening date of the registrations in RFC 3339 format (combined date, time and utc offset)
Format: datetime
Example: "1999-01-01T00:00:00+00:00"
registration_closing_datetime
string|null
The closing date of the registrations in RFC 3339 format (combined date, time and utc offset)
Format: datetime
Example: "1999-01-01T00:00:00+00:00"

POST /tournaments

Creates a new tournament.

Resource URL

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

HTTP headers

X-Api-Key
string
API key of your application (see Authentication)
Authorization
string
Access token with organizer:admin scope (see Authorization)
Content-Language
array
List of languages by priority in which the content is set.
Example: pt-BR

Query Parameters

multilingual
integer
Activate description, rules and prize fields as objects with local properties. Please read the Languages documentation.
Possible values: 0, 1
Default: 0

Request Body

Tournament data

Example

{
    "discipline": "counterstrike_go",
    "name": "My Weekly Tournament",
    "participant_type": "single",
    "size": 16,
    "timezone": "America\/Sao_Paulo",
    "platforms": [
        "pc"
    ],
    "full_name": "My Weekly Tournament - Long title",
    "scheduled_date_start": "2015-09-06",
    "scheduled_date_end": "2015-09-07",
    "public": true,
    "online": true,
    "location": "London",
    "country": "GB",
    "registration_enabled": true,
    "registration_opening_datetime": "1999-01-01T00:00:00+00:00",
    "registration_closing_datetime": "1999-01-01T00:00:00+00:00",
    "organization": "Avery Bullock",
    "contact": "[email protected]",
    "discord": "https:\/\/discord.gg\/blablabla",
    "website": "http:\/\/www.toornament.com",
    "description": "My description\non multiple lines.",
    "rules": "My rules\non multiple lines.",
    "prize": "1 - 10,000$\n2 - 5,000$",
    "match_report_enabled": false,
    "registration_auto_accept_enabled": false,
    "check_in_enabled": true,
    "check_in_participant_enabled": true,
    "check_in_participant_start_datetime": "1999-01-01T00:00:00+00:00",
    "check_in_participant_end_datetime": "1999-01-01T00:00:00+00:00",
    "archived": false,
    "locales": {
        "en_GB": {
            "default": true
        },
        "fr": {
            "default": false
        }
    },
    "registration_notification_enabled": true,
    "registration_participant_email_enabled": true,
    "registration_request_message": "For more info, go there -> []",
    "registration_acceptance_message": "You must now follow the next steps -> []",
    "registration_refusal_message": "Sorry, your registration has been refused.",
    "registration_terms_enabled": true,
    "registration_terms_url": "https:\/\/download.my\/terms.pdf",
    "registration_external_enabled": false,
    "registration_external_url": "https:\/\/esports.mywebsite.com\/event-registrations",
    "registration_restrictions": {
        "age": {
            "enabled": true,
            "required": false,
            "min": 13,
            "max": null,
            "date_reference": "2015-09-06"
        },
        "country": {
            "enabled": true,
            "required": false,
            "allowed": [
                "DE"
            ]
        },
        "game_id": {
            "enabled": true,
            "required": false
        }
    },
    "registration_permanent_team_mandatory": false,
    "logo": {
        "id": "7074908991469559808"
    },
    "background": {
        "id": "7074898466316419073"
    },
    "team_min_size": 2,
    "team_max_size": 5
}

Structure (object)

discipline
string
A unique identifier of the tournament’s discipline.
Example: "counterstrike_go"
name
string
The name of the tournament.
Max. length: 30 characters
Example: "My Weekly Tournament"
participant_type
string
The type of participants that play in the tournament.
Possible values: team, single
size
integer
The expected number of participants in the tournament.
Example: 16
timezone
string
A time zone from the IANA tz database. For more information, please read the Time Zones documentation.
Example: "America/Sao_Paulo"
platforms
array[string]
The platform on which the tournament will be played.
Possible values: pc, playstation4, playstation5, xbox_one, xbox_series, nintendo_switch, nintendo_switch2, mobile, playstation3, xbox360, playstation2, playstation1, ps_vita, psp, xbox, wii_u, wii, gamecube, nintendo64, snes, nes, 3ds, ds, game_boy, dreamcast, saturn, megadrive, master_system, neo_geo, tabletop, other_platform, not_video_game
full_name
string|null
Optional
The complete name of the tournament.
Max. length: 80 characters
Example: "My Weekly Tournament - Long title"
scheduled_date_start
string|null
Optional
A starting date in ISO 8601 format (only the date part, with YYYY-MM-DD pattern).
Format: date
Example: "2015-09-06"
scheduled_date_end
string|null
Optional
An ending date in ISO 8601 format (only the date part, with YYYY-MM-DD pattern).
Format: date
Example: "2015-09-07"
public
boolean
Optional
Whether the tournament is published or not.
Example: true
online
boolean|null
Optional
Whether the tournament is played on internet or not.
Example: true
location
string|null
Optional
The region, city, address or place of interest where the tournament is held.
Max. length: 140 characters
Example: "London"
country
string|null
Optional
The country where the tournament is played. Some codes may not be supported. (format is ISO 3166-1 alpha-2)
Example: "GB"
registration_enabled
boolean
Optional
Whether the registration process is enabled.
Example: true
registration_opening_datetime
string|null
Optional
The opening date of the registrations in RFC 3339 format (combined date, time and utc offset).
Format: datetime
Example: "1999-01-01T00:00:00+00:00"
registration_closing_datetime
string|null
Optional
The closing date of the registrations in RFC 3339 format (combined date, time and utc offset).
Format: datetime
Example: "1999-01-01T00:00:00+00:00"
organization
string|null
Optional
The name of the organizer, be it an individual, group, association or company.
Max. length: 80 characters
Example: "Avery Bullock"
contact
string|null
Optional
The email address to contact the organizer.
Format: email
Max. length: 255 characters
Example: "[email protected]"
discord
string|null
Optional
Invite URL to the tournament Discord server.
Format: uri
Max. length: 255 characters
Example: "https://discord.gg/blablabla"
website
string|null
Optional
The tournament's official website URL.
Format: uri
Max. length: 255 characters
Example: "http://www.toornament.com"
description
string|null
Optional
A description of the tournament. Multilingual supported.
Max. length: 1,500 characters
Example: "My description\non multiple lines."
rules
string|null
Optional
The rules of the tournament. Multilingual supported.
Max. length: 64,000 characters
Example: "My rules\non multiple lines."
prize
string|null
Optional
The prizes of the tournament. Multilingual supported.
Max. length: 1,500 characters
Example: "1 - 10,000$\n2 - 5,000$"
match_report_enabled
boolean
Optional
Whether the participant's match report is enabled or not.
Example: false
registration_auto_accept_enabled
boolean
Optional
Whether to automatically accept new registrations in the tournament or not.
Example: false
check_in_enabled
boolean
Optional
Whether to enable the check-in or not.
Example: true
check_in_participant_enabled
boolean
Optional
Whether to enable the check-in for participants or not.
Example: true
check_in_participant_start_datetime
string|null
Optional
The date and time of the start of the participant check-in, in RFC 3339 format (combined date, time and utc offset).
Format: datetime
Example: "1999-01-01T00:00:00+00:00"
check_in_participant_end_datetime
string|null
Optional
The date and time of the end of the participant check-in, in RFC 3339 format (combined date, time and utc offset).
Format: datetime
Example: "1999-01-01T00:00:00+00:00"
archived
boolean
Optional
Whether the tournament is archived or not.
Example: false
locales
object|null
Optional
The list of locales manages by this tournament. Accepts only locales "en_US", "en_GB" "de", "es", "fr", "pl", "pt_BR", "ar" and "id".
Example: {"en_GB":{"default":true},"fr":{"default":false}}
registration_notification_enabled
boolean
Optional
Whether to notify organizers when new registrations occur or not.
Example: true
registration_participant_email_enabled
boolean
Optional
Whether to notify participants when they register to a tournament, and when their registration status changes.
Example: true
registration_request_message
string|null
Optional
The message provided by the organizer for people who want to register.
Max. length: 20,000 characters
Example: "For more info, go there -> []"
registration_acceptance_message
string|null
Optional
The message sent to a player when his registration is accepted.
Max. length: 20,000 characters
Example: "You must now follow the next steps -> []"
registration_refusal_message
string|null
Optional
The message sent to a player when his registration is refused.
Max. length: 20,000 characters
Example: "Sorry, your registration has been refused."
registration_terms_enabled
boolean
Optional
Whether custom 'terms of use' are required.
Example: true
registration_terms_url
string|null
Optional
If enabled, the URL of the custom 'terms of use'.
Format: uri
Max. length: 2,000 characters
Example: "https://download.my/terms.pdf"
registration_external_enabled
boolean
Optional
Whether another website used for registration process.
Example: false
registration_external_url
string|null
Optional
If enabled, the official registration page will redirect on external URL.
Format: uri
Max. length: 2,000 characters
Example: "https://esports.mywebsite.com/event-registrations"
registration_restrictions
object
Optional
The tournament registration restriction settings.
- age
  object
  The tournament registration restriction about player-user birthdate.
  - enabled
    boolean
    Whether the tournament registration restriction age is enabled.
    Example: true
  - required
    boolean
    Whether the player-user birthdate is required in the registration.
    Example: false
  - min
    integer|null
    Minimal age (calculate from the date reference) of a player-user in the registration.
    Example: 13
  - max
    integer|null
    Maximal age (calculate from the date reference) of a player-user in the registration.
  - date_reference
    string|null
    An ISO 8601 date (only the date part, with YYYY-MM-DD pattern) used to calculate the age of player-user in the registration. We recommend using the date of the start of the tournament.
    Format: date
    Example: "2015-09-06"
- country
  object
  The tournament registration restriction about player-user country.
  - enabled
    boolean
    Whether the tournament registration restriction country is enabled.
    Example: true
  - required
    boolean
    Whether the player-user country is required in the registration.
    Example: false
  - allowed
    array[string]|null
    List of the countries, with format ISO 3166-1 alpha-2 country codes.
    Example: ["DE"]
- game_id
  object
  The tournament registration restriction about player-user game identifier.
  - enabled
    boolean
    Whether the tournament registration restriction game identifier is enabled. Always true if game integration is enabled in the tournament.
    Example: true
  - required
    boolean
    Whether the player-user game identifier is required in the registration. Always true if game integration is enabled in the tournament.
    Example: false
registration_permanent_team_mandatory
boolean
Optional
Whether registration only allow permanent team.
Example: false
logo
object|null
Optional
The tournament logo.
- id
  string
  The unique identifier of a file (with context "tournament_logo"), that can be used in other APIs.
  Example: "7074908991469559808"
background
object|null
Optional
The tournament background (Pro Plan and above).
- id
  string
  The unique identifier of a file (with context "tournament_background"), that can be used in other APIs.
  Example: "7074898466316419073"
team_min_size
integer
Optional
The smallest possible team size (only if the tournament participant type is “team”).
Example: 2
team_max_size
integer
Optional
The largest possible team size (only if the tournament participant type is “team”).
Example: 5

Response

[201] Tournament created.

Example

{
    "team_min_size": 2,
    "team_max_size": 5,
    "id": "378426939508809728",
    "discipline": "my_discipline",
    "name": "My Weekly Tournament",
    "full_name": "My Weekly Tournament - Long title",
    "description": "My description\non multiple lines.",
    "rules": "My rules\non multiple lines.",
    "status": "running",
    "participant_type": "single",
    "organization": "Avery Bullock",
    "contact": "[email protected]",
    "discord": "https:\/\/discord.gg\/blablabla",
    "website": "http:\/\/www.toornament.com",
    "online": true,
    "location": "London",
    "country": "GB",
    "size": 16,
    "prize": "1 - 10,000$\n2 - 5,000$",
    "scheduled_date_start": "2015-09-06",
    "scheduled_date_end": "2015-09-07",
    "timezone": "America\/Sao_Paulo",
    "public": true,
    "logo": {
        "id": "7074908991469559808",
        "logo_small": "https:\/\/api.toornament.com\/toornament\/media\/file\/7074908991469559808\/logo_small",
        "logo_medium": "https:\/\/api.toornament.com\/toornament\/media\/file\/7074908991469559808\/logo_medium",
        "logo_large": "https:\/\/api.toornament.com\/toornament\/media\/file\/7074908991469559808\/logo_large",
        "original": "https:\/\/api.toornament.com\/toornament\/media\/file\/7074908991469559808\/original"
    },
    "background": {
        "id": "7074898466316419073",
        "small_4x1": "https:\/\/api.toornament.com\/toornament\/media\/file\/7074898466316419073\/small_4x1",
        "medium_4x1": "https:\/\/api.toornament.com\/toornament\/media\/file\/7074898466316419073\/medium_4x1",
        "full_4x1": "https:\/\/api.toornament.com\/toornament\/media\/file\/7074898466316419073\/full_4x1",
        "original": "https:\/\/api.toornament.com\/toornament\/media\/file\/7074898466316419073\/original"
    },
    "platforms": [
        "pc"
    ],
    "featured": true,
    "archived": false,
    "locales": {
        "en_GB": {
            "default": true
        },
        "fr": {
            "default": false
        }
    },
    "match_report_enabled": false,
    "registration_enabled": true,
    "registration_auto_accept_enabled": false,
    "registration_opening_datetime": "1999-01-01T00:00:00+00:00",
    "registration_closing_datetime": "1999-01-01T00:00:00+00:00",
    "registration_notification_enabled": true,
    "registration_participant_email_enabled": true,
    "registration_request_message": "For more info, go there -> []",
    "registration_acceptance_message": "You must now follow the next steps -> []",
    "registration_refusal_message": "Sorry, your registration has been refused.",
    "registration_terms_enabled": true,
    "registration_terms_url": "https:\/\/download.my\/terms.pdf",
    "registration_external_enabled": false,
    "registration_external_url": "https:\/\/esports.mywebsite.com\/event-registrations",
    "registration_permanent_team_mandatory": false,
    "registration_restrictions": {
        "age": {
            "enabled": true,
            "required": false,
            "min": 13,
            "max": null,
            "date_reference": "2015-09-06"
        },
        "country": {
            "enabled": true,
            "required": false,
            "allowed": [
                "DE"
            ]
        },
        "game_id": {
            "enabled": true,
            "required": false
        }
    },
    "check_in_enabled": true,
    "check_in_participant_enabled": true,
    "check_in_participant_start_datetime": "1999-01-01T00:00:00+00:00",
    "check_in_participant_end_datetime": "1999-01-01T00:00:00+00:00",
    "circuit": {
        "id": "5756452414364442624",
        "name": "Challenger League"
    },
    "circuit_season": {
        "id": "5756460443435106304",
        "name": "Season 42",
        "machine_name": "season_42"
    },
    "circuit_region": {
        "id": "5756460443435106304",
        "name": "Europe",
        "machine_name": "europe"
    },
    "circuit_tier": {
        "id": "5756492752630054912",
        "name": "Top",
        "machine_name": "top"
    }
}

Structure (object)

team_min_size
integer
The smallest possible team size (only if the tournament participant type is “team”).
Example: 2
team_max_size
integer
The largest possible team size (only if the tournament participant type is “team”).
Example: 5
id
string
The unique identifier of the tournament.
Example: "378426939508809728"
discipline
string
A unique identifier of the tournament’s discipline.
Example: "my_discipline"
name
string
The name of the tournament.
Max. length: 30 characters
Example: "My Weekly Tournament"
full_name
string|null
The complete name of the tournament.
Max. length: 80 characters
Example: "My Weekly Tournament - Long title"
description
string|null
A description of the tournament. Multilingual supported.
Max. length: 1,500 characters
Example: "My description\non multiple lines."
rules
string|null
The rules of the tournament. Multilingual supported.
Max. length: 64,000 characters
Example: "My rules\non multiple lines."
status
string
The status of the tournament.
Possible values: pending, running, completed
participant_type
string
The type of participants that play in the tournament.
Possible values: team, single
organization
string|null
The name of the organizer, be it an individual, group, association or company.
Max. length: 80 characters
Example: "Avery Bullock"
contact
string|null
The email address to contact the organizer.
Format: email
Max. length: 255 characters
Example: "[email protected]"
discord
string|null
Invite URL to the tournament Discord server.
Format: uri
Max. length: 255 characters
Example: "https://discord.gg/blablabla"
website
string|null
The tournament's official website URL.
Format: uri
Max. length: 255 characters
Example: "http://www.toornament.com"
online
boolean|null
Whether the tournament is played on internet or not.
Example: true
location
string|null
The region, city, address or place of interest where the tournament is held.
Max. length: 140 characters
Example: "London"
country
string|null
The country where the tournament is played. Some codes may not be supported. (format is ISO 3166-1 alpha-2)
Example: "GB"
size
integer
The expected number of participants in the tournament.
Example: 16
prize
string|null
The prizes of the tournament. Multilingual supported.
Max. length: 1,500 characters
Example: "1 - 10,000$\n2 - 5,000$"
scheduled_date_start
string|null
A starting date in ISO 8601 format (only the date part, with YYYY-MM-DD pattern).
Format: date
Example: "2015-09-06"
scheduled_date_end
string|null
An ending date in ISO 8601 format (only the date part, with YYYY-MM-DD pattern).
Format: date
Example: "2015-09-07"
timezone
string
A time zone from the IANA tz database. For more information, please read the Time Zones documentation.
Example: "America/Sao_Paulo"
public
boolean
Whether the tournament is published or not.
Example: true
logo
object|null
The tournament logo in every available format.
- id
  string
  The unique identifier of a file (with context "tournament_logo"), that can be used in other APIs.
  Example: "7074908991469559808"
- logo_small
  string
  URL of the small version of the tournament logo.
  Example: "https://api.toornament.com/toornament/media/file/7074908991469559808/logo_small"
- logo_medium
  string
  URL of the medium version of the tournament logo.
  Example: "https://api.toornament.com/toornament/media/file/7074908991469559808/logo_medium"
- logo_large
  string
  URL of the large version of the tournament logo.
  Example: "https://api.toornament.com/toornament/media/file/7074908991469559808/logo_large"
- original
  string
  URL of the original version of the tournament logo.
  Example: "https://api.toornament.com/toornament/media/file/7074908991469559808/original"
background
object|null
The tournament background in every available format (Pro plan).
- id
  string
  The unique identifier of a file (with context "tournament_background"), that can be used in other APIs.
  Example: "7074898466316419073"
- small_4x1
  string
  URL of the small version of the tournament background.
  Example: "https://api.toornament.com/toornament/media/file/7074898466316419073/small_4x1"
- medium_4x1
  string
  URL of the medium version of the tournament background.
  Example: "https://api.toornament.com/toornament/media/file/7074898466316419073/medium_4x1"
- full_4x1
  string
  URL of the full version of the tournament background.
  Example: "https://api.toornament.com/toornament/media/file/7074898466316419073/full_4x1"
- original
  string
  URL of the original version of the tournament background.
  Example: "https://api.toornament.com/toornament/media/file/7074898466316419073/original"
platforms
array[string]
The platform on which the tournament will be played.
Possible values: pc, playstation4, playstation5, xbox_one, xbox_series, nintendo_switch, nintendo_switch2, mobile, playstation3, xbox360, playstation2, playstation1, ps_vita, psp, xbox, wii_u, wii, gamecube, nintendo64, snes, nes, 3ds, ds, game_boy, dreamcast, saturn, megadrive, master_system, neo_geo, tabletop, other_platform, not_video_game
featured
boolean
Whether the tournament is featured or not.
Example: true
archived
boolean
Whether the tournament is archived or not.
Example: false
locales
object|null
The list of locales manages by this tournament. Accepts only locales "en_US", "en_GB" "de", "es", "fr", "pl", "pt_BR", "ar" and "id".
Example: {"en_GB":{"default":true},"fr":{"default":false}}
match_report_enabled
boolean
Whether the participant's match report is enabled or not.
Example: false
registration_enabled
boolean
Whether the registration process is enabled.
Example: true
registration_auto_accept_enabled
boolean
Whether to automatically accept new registrations in the tournament or not.
Example: false
registration_opening_datetime
string|null
The opening date of the registrations in RFC 3339 format (combined date, time and utc offset).
Format: datetime
Example: "1999-01-01T00:00:00+00:00"
registration_closing_datetime
string|null
The closing date of the registrations in RFC 3339 format (combined date, time and utc offset).
Format: datetime
Example: "1999-01-01T00:00:00+00:00"
registration_notification_enabled
boolean
Whether to notify organizers when new registrations occur or not.
Example: true
registration_participant_email_enabled
boolean
Whether to notify participants when they register to a tournament, and when their registration status changes.
Example: true
registration_request_message
string|null
The message provided by the organizer for people who want to register.
Max. length: 20,000 characters
Example: "For more info, go there -> []"
registration_acceptance_message
string|null
The message sent to a player when his registration is accepted.
Max. length: 20,000 characters
Example: "You must now follow the next steps -> []"
registration_refusal_message
string|null
The message sent to a player when his registration is refused.
Max. length: 20,000 characters
Example: "Sorry, your registration has been refused."
registration_terms_enabled
boolean
Whether custom 'terms of use' are required.
Example: true
registration_terms_url
string|null
If enabled, the URL of the custom 'terms of use'.
Format: uri
Max. length: 2,000 characters
Example: "https://download.my/terms.pdf"
registration_external_enabled
boolean
Whether another website used for registration process.
Example: false
registration_external_url
string|null
If enabled, the official registration page will redirect on external URL.
Format: uri
Max. length: 2,000 characters
Example: "https://esports.mywebsite.com/event-registrations"
registration_permanent_team_mandatory
boolean
Whether registration only allow permanent team.
Example: false
registration_restrictions
object
The tournament registration restriction settings.
- age
  object
  The tournament registration restriction about player-user birthdate.
  - enabled
    boolean
    Whether the tournament registration restriction age is enabled.
    Example: true
  - required
    boolean
    Whether the player-user birthdate is required in the registration.
    Example: false
  - min
    integer|null
    Minimal age (calculate from the date reference) of a player-user in the registration.
    Example: 13
  - max
    integer|null
    Maximal age (calculate from the date reference) of a player-user in the registration.
  - date_reference
    string|null
    An ISO 8601 date (only the date part, with YYYY-MM-DD pattern) used to calculate the age of player-user in the registration. We recommend using the date of the start of the tournament.
    Format: date
    Example: "2015-09-06"
- country
  object
  The tournament registration restriction about player-user country.
  - enabled
    boolean
    Whether the tournament registration restriction country is enabled.
    Example: true
  - required
    boolean
    Whether the player-user country is required in the registration.
    Example: false
  - allowed
    array[string]|null
    List of the countries, with format ISO 3166-1 alpha-2 country codes.
    Example: ["DE"]
- game_id
  object
  The tournament registration restriction about player-user game identifier.
  - enabled
    boolean
    Whether the tournament registration restriction game identifier is enabled. Always true if game integration is enabled in the tournament.
    Example: true
  - required
    boolean
    Whether the player-user game identifier is required in the registration. Always true if game integration is enabled in the tournament.
    Example: false
check_in_enabled
boolean
Whether to enable the check-in or not.
Example: true
check_in_participant_enabled
boolean
Whether to enable the check-in for participants or not.
Example: true
check_in_participant_start_datetime
string|null
The date and time of the start of the participant check-in, in RFC 3339 format (combined date, time and utc offset).
Format: datetime
Example: "1999-01-01T00:00:00+00:00"
check_in_participant_end_datetime
string|null
The date and time of the end of the participant check-in, in RFC 3339 format (combined date, time and utc offset).
Format: datetime
Example: "1999-01-01T00:00:00+00:00"
circuit
object|null
The circuit associated with this tournament.
- id
  string
  The id of the circuit.
  Example: "5756452414364442624"
- name
  string
  The name of the circuit.
  Max. length: 40 characters
  Example: "Challenger League"
circuit_season
object|null
The circuit season associated with this tournament.
- id
  string
  The id of the circuit season.
  Example: "5756460443435106304"
- name
  string
  The name of the circuit season.
  Max. length: 40 characters
  Example: "Season 42"
- machine_name
  string
  A name used to identify a circuit season.
  Pattern: ^[a-z0-9_]+$
  Max. length: 40 characters
  Example: "season_42"
circuit_region
object|null
The circuit region associated with this tournament.
- id
  string
  The id of the circuit region.
  Example: "5756460443435106304"
- name
  string
  The name of the circuit region.
  Max. length: 40 characters
  Example: "Europe"
- machine_name
  string
  A name used to identify a circuit region.
  Pattern: ^[a-z0-9_]+$
  Max. length: 40 characters
  Example: "europe"
circuit_tier
object|null
The circuit tier associated with this tournament.
- id
  string
  The id of the circuit tier.
  Example: "5756492752630054912"
- name
  string
  The name of the circuit tier.
  Max. length: 40 characters
  Example: "Top"
- machine_name
  string
  A name used to identify a circuit tier.
  Pattern: ^[a-z0-9_]+$
  Max. length: 40 characters
  Example: "top"

GET /tournaments/{id}

Returns a tournament identified with the given id with all organizer-specific data.

Resource URL

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

HTTP headers

X-Api-Key
string
API key of your application (see Authentication)
Authorization
string
Access token with organizer:view scope (see Authorization)
Accept-Language
array
List of languages by priority in which content is retrieved.
Example: de,es,fr,en-GB

Path parameters

id
string
The id of the tournament.

Query Parameters

multilingual
integer
Activate description, rules and prize fields as objects with local properties. Please read the Languages documentation.
Possible values: 0, 1
Default: 0

Request Body

This endpoint does not require a request body.

Response

[200] Tournament retrieved.

Example

{
    "team_min_size": 2,
    "team_max_size": 5,
    "id": "378426939508809728",
    "discipline": "my_discipline",
    "name": "My Weekly Tournament",
    "full_name": "My Weekly Tournament - Long title",
    "description": "My description\non multiple lines.",
    "rules": "My rules\non multiple lines.",
    "status": "running",
    "participant_type": "single",
    "organization": "Avery Bullock",
    "contact": "[email protected]",
    "discord": "https:\/\/discord.gg\/blablabla",
    "website": "http:\/\/www.toornament.com",
    "online": true,
    "location": "London",
    "country": "GB",
    "size": 16,
    "prize": "1 - 10,000$\n2 - 5,000$",
    "scheduled_date_start": "2015-09-06",
    "scheduled_date_end": "2015-09-07",
    "timezone": "America\/Sao_Paulo",
    "public": true,
    "logo": {
        "id": "7074908991469559808",
        "logo_small": "https:\/\/api.toornament.com\/toornament\/media\/file\/7074908991469559808\/logo_small",
        "logo_medium": "https:\/\/api.toornament.com\/toornament\/media\/file\/7074908991469559808\/logo_medium",
        "logo_large": "https:\/\/api.toornament.com\/toornament\/media\/file\/7074908991469559808\/logo_large",
        "original": "https:\/\/api.toornament.com\/toornament\/media\/file\/7074908991469559808\/original"
    },
    "background": {
        "id": "7074898466316419073",
        "small_4x1": "https:\/\/api.toornament.com\/toornament\/media\/file\/7074898466316419073\/small_4x1",
        "medium_4x1": "https:\/\/api.toornament.com\/toornament\/media\/file\/7074898466316419073\/medium_4x1",
        "full_4x1": "https:\/\/api.toornament.com\/toornament\/media\/file\/7074898466316419073\/full_4x1",
        "original": "https:\/\/api.toornament.com\/toornament\/media\/file\/7074898466316419073\/original"
    },
    "platforms": [
        "pc"
    ],
    "featured": true,
    "archived": false,
    "locales": {
        "en_GB": {
            "default": true
        },
        "fr": {
            "default": false
        }
    },
    "match_report_enabled": false,
    "registration_enabled": true,
    "registration_auto_accept_enabled": false,
    "registration_opening_datetime": "1999-01-01T00:00:00+00:00",
    "registration_closing_datetime": "1999-01-01T00:00:00+00:00",
    "registration_notification_enabled": true,
    "registration_participant_email_enabled": true,
    "registration_request_message": "For more info, go there -> []",
    "registration_acceptance_message": "You must now follow the next steps -> []",
    "registration_refusal_message": "Sorry, your registration has been refused.",
    "registration_terms_enabled": true,
    "registration_terms_url": "https:\/\/download.my\/terms.pdf",
    "registration_external_enabled": false,
    "registration_external_url": "https:\/\/esports.mywebsite.com\/event-registrations",
    "registration_permanent_team_mandatory": false,
    "registration_restrictions": {
        "age": {
            "enabled": true,
            "required": false,
            "min": 13,
            "max": null,
            "date_reference": "2015-09-06"
        },
        "country": {
            "enabled": true,
            "required": false,
            "allowed": [
                "DE"
            ]
        },
        "game_id": {
            "enabled": true,
            "required": false
        }
    },
    "check_in_enabled": true,
    "check_in_participant_enabled": true,
    "check_in_participant_start_datetime": "1999-01-01T00:00:00+00:00",
    "check_in_participant_end_datetime": "1999-01-01T00:00:00+00:00",
    "circuit": {
        "id": "5756452414364442624",
        "name": "Challenger League"
    },
    "circuit_season": {
        "id": "5756460443435106304",
        "name": "Season 42",
        "machine_name": "season_42"
    },
    "circuit_region": {
        "id": "5756460443435106304",
        "name": "Europe",
        "machine_name": "europe"
    },
    "circuit_tier": {
        "id": "5756492752630054912",
        "name": "Top",
        "machine_name": "top"
    }
}

Structure (object)

team_min_size
integer
The smallest possible team size (only if the tournament participant type is “team”).
Example: 2
team_max_size
integer
The largest possible team size (only if the tournament participant type is “team”).
Example: 5
id
string
The unique identifier of the tournament.
Example: "378426939508809728"
discipline
string
A unique identifier of the tournament’s discipline.
Example: "my_discipline"
name
string
The name of the tournament.
Max. length: 30 characters
Example: "My Weekly Tournament"
full_name
string|null
The complete name of the tournament.
Max. length: 80 characters
Example: "My Weekly Tournament - Long title"
description
string|null
A description of the tournament. Multilingual supported.
Max. length: 1,500 characters
Example: "My description\non multiple lines."
rules
string|null
The rules of the tournament. Multilingual supported.
Max. length: 64,000 characters
Example: "My rules\non multiple lines."
status
string
The status of the tournament.
Possible values: pending, running, completed
participant_type
string
The type of participants that play in the tournament.
Possible values: team, single
organization
string|null
The name of the organizer, be it an individual, group, association or company.
Max. length: 80 characters
Example: "Avery Bullock"
contact
string|null
The email address to contact the organizer.
Format: email
Max. length: 255 characters
Example: "[email protected]"
discord
string|null
Invite URL to the tournament Discord server.
Format: uri
Max. length: 255 characters
Example: "https://discord.gg/blablabla"
website
string|null
The tournament's official website URL.
Format: uri
Max. length: 255 characters
Example: "http://www.toornament.com"
online
boolean|null
Whether the tournament is played on internet or not.
Example: true
location
string|null
The region, city, address or place of interest where the tournament is held.
Max. length: 140 characters
Example: "London"
country
string|null
The country where the tournament is played. Some codes may not be supported. (format is ISO 3166-1 alpha-2)
Example: "GB"
size
integer
The expected number of participants in the tournament.
Example: 16
prize
string|null
The prizes of the tournament. Multilingual supported.
Max. length: 1,500 characters
Example: "1 - 10,000$\n2 - 5,000$"
scheduled_date_start
string|null
A starting date in ISO 8601 format (only the date part, with YYYY-MM-DD pattern).
Format: date
Example: "2015-09-06"
scheduled_date_end
string|null
An ending date in ISO 8601 format (only the date part, with YYYY-MM-DD pattern).
Format: date
Example: "2015-09-07"
timezone
string
A time zone from the IANA tz database. For more information, please read the Time Zones documentation.
Example: "America/Sao_Paulo"
public
boolean
Whether the tournament is published or not.
Example: true
logo
object|null
The tournament logo in every available format.
- id
  string
  The unique identifier of a file (with context "tournament_logo"), that can be used in other APIs.
  Example: "7074908991469559808"
- logo_small
  string
  URL of the small version of the tournament logo.
  Example: "https://api.toornament.com/toornament/media/file/7074908991469559808/logo_small"
- logo_medium
  string
  URL of the medium version of the tournament logo.
  Example: "https://api.toornament.com/toornament/media/file/7074908991469559808/logo_medium"
- logo_large
  string
  URL of the large version of the tournament logo.
  Example: "https://api.toornament.com/toornament/media/file/7074908991469559808/logo_large"
- original
  string
  URL of the original version of the tournament logo.
  Example: "https://api.toornament.com/toornament/media/file/7074908991469559808/original"
background
object|null
The tournament background in every available format (Pro plan).
- id
  string
  The unique identifier of a file (with context "tournament_background"), that can be used in other APIs.
  Example: "7074898466316419073"
- small_4x1
  string
  URL of the small version of the tournament background.
  Example: "https://api.toornament.com/toornament/media/file/7074898466316419073/small_4x1"
- medium_4x1
  string
  URL of the medium version of the tournament background.
  Example: "https://api.toornament.com/toornament/media/file/7074898466316419073/medium_4x1"
- full_4x1
  string
  URL of the full version of the tournament background.
  Example: "https://api.toornament.com/toornament/media/file/7074898466316419073/full_4x1"
- original
  string
  URL of the original version of the tournament background.
  Example: "https://api.toornament.com/toornament/media/file/7074898466316419073/original"
platforms
array[string]
The platform on which the tournament will be played.
Possible values: pc, playstation4, playstation5, xbox_one, xbox_series, nintendo_switch, nintendo_switch2, mobile, playstation3, xbox360, playstation2, playstation1, ps_vita, psp, xbox, wii_u, wii, gamecube, nintendo64, snes, nes, 3ds, ds, game_boy, dreamcast, saturn, megadrive, master_system, neo_geo, tabletop, other_platform, not_video_game
featured
boolean
Whether the tournament is featured or not.
Example: true
archived
boolean
Whether the tournament is archived or not.
Example: false
locales
object|null
The list of locales manages by this tournament. Accepts only locales "en_US", "en_GB" "de", "es", "fr", "pl", "pt_BR", "ar" and "id".
Example: {"en_GB":{"default":true},"fr":{"default":false}}
match_report_enabled
boolean
Whether the participant's match report is enabled or not.
Example: false
registration_enabled
boolean
Whether the registration process is enabled.
Example: true
registration_auto_accept_enabled
boolean
Whether to automatically accept new registrations in the tournament or not.
Example: false
registration_opening_datetime
string|null
The opening date of the registrations in RFC 3339 format (combined date, time and utc offset).
Format: datetime
Example: "1999-01-01T00:00:00+00:00"
registration_closing_datetime
string|null
The closing date of the registrations in RFC 3339 format (combined date, time and utc offset).
Format: datetime
Example: "1999-01-01T00:00:00+00:00"
registration_notification_enabled
boolean
Whether to notify organizers when new registrations occur or not.
Example: true
registration_participant_email_enabled
boolean
Whether to notify participants when they register to a tournament, and when their registration status changes.
Example: true
registration_request_message
string|null
The message provided by the organizer for people who want to register.
Max. length: 20,000 characters
Example: "For more info, go there -> []"
registration_acceptance_message
string|null
The message sent to a player when his registration is accepted.
Max. length: 20,000 characters
Example: "You must now follow the next steps -> []"
registration_refusal_message
string|null
The message sent to a player when his registration is refused.
Max. length: 20,000 characters
Example: "Sorry, your registration has been refused."
registration_terms_enabled
boolean
Whether custom 'terms of use' are required.
Example: true
registration_terms_url
string|null
If enabled, the URL of the custom 'terms of use'.
Format: uri
Max. length: 2,000 characters
Example: "https://download.my/terms.pdf"
registration_external_enabled
boolean
Whether another website used for registration process.
Example: false
registration_external_url
string|null
If enabled, the official registration page will redirect on external URL.
Format: uri
Max. length: 2,000 characters
Example: "https://esports.mywebsite.com/event-registrations"
registration_permanent_team_mandatory
boolean
Whether registration only allow permanent team.
Example: false
registration_restrictions
object
The tournament registration restriction settings.
- age
  object
  The tournament registration restriction about player-user birthdate.
  - enabled
    boolean
    Whether the tournament registration restriction age is enabled.
    Example: true
  - required
    boolean
    Whether the player-user birthdate is required in the registration.
    Example: false
  - min
    integer|null
    Minimal age (calculate from the date reference) of a player-user in the registration.
    Example: 13
  - max
    integer|null
    Maximal age (calculate from the date reference) of a player-user in the registration.
  - date_reference
    string|null
    An ISO 8601 date (only the date part, with YYYY-MM-DD pattern) used to calculate the age of player-user in the registration. We recommend using the date of the start of the tournament.
    Format: date
    Example: "2015-09-06"
- country
  object
  The tournament registration restriction about player-user country.
  - enabled
    boolean
    Whether the tournament registration restriction country is enabled.
    Example: true
  - required
    boolean
    Whether the player-user country is required in the registration.
    Example: false
  - allowed
    array[string]|null
    List of the countries, with format ISO 3166-1 alpha-2 country codes.
    Example: ["DE"]
- game_id
  object
  The tournament registration restriction about player-user game identifier.
  - enabled
    boolean
    Whether the tournament registration restriction game identifier is enabled. Always true if game integration is enabled in the tournament.
    Example: true
  - required
    boolean
    Whether the player-user game identifier is required in the registration. Always true if game integration is enabled in the tournament.
    Example: false
check_in_enabled
boolean
Whether to enable the check-in or not.
Example: true
check_in_participant_enabled
boolean
Whether to enable the check-in for participants or not.
Example: true
check_in_participant_start_datetime
string|null
The date and time of the start of the participant check-in, in RFC 3339 format (combined date, time and utc offset).
Format: datetime
Example: "1999-01-01T00:00:00+00:00"
check_in_participant_end_datetime
string|null
The date and time of the end of the participant check-in, in RFC 3339 format (combined date, time and utc offset).
Format: datetime
Example: "1999-01-01T00:00:00+00:00"
circuit
object|null
The circuit associated with this tournament.
- id
  string
  The id of the circuit.
  Example: "5756452414364442624"
- name
  string
  The name of the circuit.
  Max. length: 40 characters
  Example: "Challenger League"
circuit_season
object|null
The circuit season associated with this tournament.
- id
  string
  The id of the circuit season.
  Example: "5756460443435106304"
- name
  string
  The name of the circuit season.
  Max. length: 40 characters
  Example: "Season 42"
- machine_name
  string
  A name used to identify a circuit season.
  Pattern: ^[a-z0-9_]+$
  Max. length: 40 characters
  Example: "season_42"
circuit_region
object|null
The circuit region associated with this tournament.
- id
  string
  The id of the circuit region.
  Example: "5756460443435106304"
- name
  string
  The name of the circuit region.
  Max. length: 40 characters
  Example: "Europe"
- machine_name
  string
  A name used to identify a circuit region.
  Pattern: ^[a-z0-9_]+$
  Max. length: 40 characters
  Example: "europe"
circuit_tier
object|null
The circuit tier associated with this tournament.
- id
  string
  The id of the circuit tier.
  Example: "5756492752630054912"
- name
  string
  The name of the circuit tier.
  Max. length: 40 characters
  Example: "Top"
- machine_name
  string
  A name used to identify a circuit tier.
  Pattern: ^[a-z0-9_]+$
  Max. length: 40 characters
  Example: "top"

PATCH /tournaments/{id}

Updates one or several fields of one of your tournaments.

Resource URL

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

HTTP headers

X-Api-Key
string
API key of your application (see Authentication)
Authorization
string
Access token with organizer:admin scope (see Authorization)
Content-Language
array
List of languages by priority in which the content is set.
Example: pt-BR

Path parameters

id
string
The id of the tournament.

Query Parameters

multilingual
integer
Activate description, rules and prize fields as objects with local properties. Please read the Languages documentation.
Possible values: 0, 1
Default: 0

Request Body

Tournament data.

Example

{
    "name": "My Weekly Tournament",
    "full_name": "My Weekly Tournament - Long title",
    "scheduled_date_start": "2015-09-06",
    "scheduled_date_end": "2015-09-07",
    "timezone": "America\/Sao_Paulo",
    "public": true,
    "size": 16,
    "online": true,
    "location": "London",
    "country": "GB",
    "registration_enabled": true,
    "registration_opening_datetime": "1999-01-01T00:00:00+00:00",
    "registration_closing_datetime": "1999-01-01T00:00:00+00:00",
    "organization": "Avery Bullock",
    "contact": "[email protected]",
    "discord": "https:\/\/discord.gg\/blablabla",
    "website": "http:\/\/www.toornament.com",
    "description": "My description\non multiple lines.",
    "rules": "My rules\non multiple lines.",
    "prize": "1 - 10,000$\n2 - 5,000$",
    "match_report_enabled": false,
    "registration_auto_accept_enabled": false,
    "check_in_enabled": true,
    "check_in_participant_enabled": true,
    "check_in_participant_start_datetime": "1999-01-01T00:00:00+00:00",
    "check_in_participant_end_datetime": "1999-01-01T00:00:00+00:00",
    "archived": false,
    "locales": {
        "en_GB": {
            "default": true
        },
        "fr": {
            "default": false
        }
    },
    "registration_notification_enabled": true,
    "registration_participant_email_enabled": true,
    "registration_request_message": "For more info, go there -> []",
    "registration_acceptance_message": "You must now follow the next steps -> []",
    "registration_refusal_message": "Sorry, your registration has been refused.",
    "registration_terms_enabled": true,
    "registration_terms_url": "https:\/\/download.my\/terms.pdf",
    "registration_external_enabled": false,
    "registration_external_url": "https:\/\/esports.mywebsite.com\/event-registrations",
    "registration_restrictions": {
        "age": {
            "enabled": true,
            "required": false,
            "min": 13,
            "max": null,
            "date_reference": "2015-09-06"
        },
        "country": {
            "enabled": true,
            "required": false,
            "allowed": [
                "DE"
            ]
        },
        "game_id": {
            "enabled": true,
            "required": false
        }
    },
    "registration_permanent_team_mandatory": false,
    "logo": {
        "id": "7074908991469559808"
    },
    "background": {
        "id": "7074898466316419073"
    },
    "team_min_size": 2,
    "team_max_size": 5
}

Structure (object)

name
string
Optional
The name of the tournament.
Max. length: 30 characters
Example: "My Weekly Tournament"
full_name
string|null
Optional
The complete name of the tournament.
Max. length: 80 characters
Example: "My Weekly Tournament - Long title"
scheduled_date_start
string|null
Optional
A starting date in ISO 8601 format (only the date part, with YYYY-MM-DD pattern).
Format: date
Example: "2015-09-06"
scheduled_date_end
string|null
Optional
An ending date in ISO 8601 format (only the date part, with YYYY-MM-DD pattern).
Format: date
Example: "2015-09-07"
timezone
string
Optional
A time zone from the IANA tz database. For more information, please read the Time Zones documentation.
Example: "America/Sao_Paulo"
public
boolean
Optional
Whether the tournament is published or not.
Example: true
size
integer
Optional
The expected number of participants in the tournament.
Example: 16
online
boolean|null
Optional
Whether the tournament is played on internet or not.
Example: true
location
string|null
Optional
The region, city, address or place of interest where the tournament is held.
Max. length: 140 characters
Example: "London"
country
string|null
Optional
The country where the tournament is played. Some codes may not be supported. (format is ISO 3166-1 alpha-2)
Example: "GB"
registration_enabled
boolean
Optional
Whether the registration process is enabled.
Example: true
registration_opening_datetime
string|null
Optional
The opening date of the registrations in RFC 3339 format (combined date, time and utc offset).
Format: datetime
Example: "1999-01-01T00:00:00+00:00"
registration_closing_datetime
string|null
Optional
The closing date of the registrations in RFC 3339 format (combined date, time and utc offset).
Format: datetime
Example: "1999-01-01T00:00:00+00:00"
organization
string|null
Optional
The name of the organizer, be it an individual, group, association or company.
Max. length: 80 characters
Example: "Avery Bullock"
contact
string|null
Optional
The email address to contact the organizer.
Format: email
Max. length: 255 characters
Example: "[email protected]"
discord
string|null
Optional
Invite URL to the tournament Discord server.
Format: uri
Max. length: 255 characters
Example: "https://discord.gg/blablabla"
website
string|null
Optional
The tournament's official website URL.
Format: uri
Max. length: 255 characters
Example: "http://www.toornament.com"
description
string|null
Optional
A description of the tournament. Multilingual supported.
Max. length: 1,500 characters
Example: "My description\non multiple lines."
rules
string|null
Optional
The rules of the tournament. Multilingual supported.
Max. length: 64,000 characters
Example: "My rules\non multiple lines."
prize
string|null
Optional
The prizes of the tournament. Multilingual supported.
Max. length: 1,500 characters
Example: "1 - 10,000$\n2 - 5,000$"
match_report_enabled
boolean
Optional
Whether the participant's match report is enabled or not.
Example: false
registration_auto_accept_enabled
boolean
Optional
Whether to automatically accept new registrations in the tournament or not.
Example: false
check_in_enabled
boolean
Optional
Whether to enable the check-in or not.
Example: true
check_in_participant_enabled
boolean
Optional
Whether to enable the check-in for participants or not.
Example: true
check_in_participant_start_datetime
string|null
Optional
The date and time of the start of the participant check-in, in RFC 3339 format (combined date, time and utc offset).
Format: datetime
Example: "1999-01-01T00:00:00+00:00"
check_in_participant_end_datetime
string|null
Optional
The date and time of the end of the participant check-in, in RFC 3339 format (combined date, time and utc offset).
Format: datetime
Example: "1999-01-01T00:00:00+00:00"
archived
boolean
Optional
Whether the tournament is archived or not.
Example: false
locales
object|null
Optional
The list of locales manages by this tournament. Accepts only locales "en_US", "en_GB" "de", "es", "fr", "pl", "pt_BR", "ar" and "id".
Example: {"en_GB":{"default":true},"fr":{"default":false}}
registration_notification_enabled
boolean
Optional
Whether to notify organizers when new registrations occur or not.
Example: true
registration_participant_email_enabled
boolean
Optional
Whether to notify participants when they register to a tournament, and when their registration status changes.
Example: true
registration_request_message
string|null
Optional
The message provided by the organizer for people who want to register.
Max. length: 20,000 characters
Example: "For more info, go there -> []"
registration_acceptance_message
string|null
Optional
The message sent to a player when his registration is accepted.
Max. length: 20,000 characters
Example: "You must now follow the next steps -> []"
registration_refusal_message
string|null
Optional
The message sent to a player when his registration is refused.
Max. length: 20,000 characters
Example: "Sorry, your registration has been refused."
registration_terms_enabled
boolean
Optional
Whether custom 'terms of use' are required.
Example: true
registration_terms_url
string|null
Optional
If enabled, the URL of the custom 'terms of use'.
Format: uri
Max. length: 2,000 characters
Example: "https://download.my/terms.pdf"
registration_external_enabled
boolean
Optional
Whether another website used for registration process.
Example: false
registration_external_url
string|null
Optional
If enabled, the official registration page will redirect on external URL.
Format: uri
Max. length: 2,000 characters
Example: "https://esports.mywebsite.com/event-registrations"
registration_restrictions
object
Optional
The tournament registration restriction settings.
- age
  object
  The tournament registration restriction about player-user birthdate.
  - enabled
    boolean
    Whether the tournament registration restriction age is enabled.
    Example: true
  - required
    boolean
    Whether the player-user birthdate is required in the registration.
    Example: false
  - min
    integer|null
    Minimal age (calculate from the date reference) of a player-user in the registration.
    Example: 13
  - max
    integer|null
    Maximal age (calculate from the date reference) of a player-user in the registration.
  - date_reference
    string|null
    An ISO 8601 date (only the date part, with YYYY-MM-DD pattern) used to calculate the age of player-user in the registration. We recommend using the date of the start of the tournament.
    Format: date
    Example: "2015-09-06"
- country
  object
  The tournament registration restriction about player-user country.
  - enabled
    boolean
    Whether the tournament registration restriction country is enabled.
    Example: true
  - required
    boolean
    Whether the player-user country is required in the registration.
    Example: false
  - allowed
    array[string]|null
    List of the countries, with format ISO 3166-1 alpha-2 country codes.
    Example: ["DE"]
- game_id
  object
  The tournament registration restriction about player-user game identifier.
  - enabled
    boolean
    Whether the tournament registration restriction game identifier is enabled. Always true if game integration is enabled in the tournament.
    Example: true
  - required
    boolean
    Whether the player-user game identifier is required in the registration. Always true if game integration is enabled in the tournament.
    Example: false
registration_permanent_team_mandatory
boolean
Optional
Whether registration only allow permanent team.
Example: false
logo
object|null
Optional
The tournament logo.
- id
  string
  The unique identifier of a file (with context "tournament_logo"), that can be used in other APIs.
  Example: "7074908991469559808"
background
object|null
Optional
The tournament background (Pro Plan and above).
- id
  string
  The unique identifier of a file (with context "tournament_background"), that can be used in other APIs.
  Example: "7074898466316419073"
team_min_size
integer
Optional
The smallest possible team size (only if the tournament participant type is “team”).
Example: 2
team_max_size
integer
Optional
The largest possible team size (only if the tournament participant type is “team”).
Example: 5

Response

[200] Success.

Example

{
    "team_min_size": 2,
    "team_max_size": 5,
    "id": "378426939508809728",
    "discipline": "my_discipline",
    "name": "My Weekly Tournament",
    "full_name": "My Weekly Tournament - Long title",
    "description": "My description\non multiple lines.",
    "rules": "My rules\non multiple lines.",
    "status": "running",
    "participant_type": "single",
    "organization": "Avery Bullock",
    "contact": "[email protected]",
    "discord": "https:\/\/discord.gg\/blablabla",
    "website": "http:\/\/www.toornament.com",
    "online": true,
    "location": "London",
    "country": "GB",
    "size": 16,
    "prize": "1 - 10,000$\n2 - 5,000$",
    "scheduled_date_start": "2015-09-06",
    "scheduled_date_end": "2015-09-07",
    "timezone": "America\/Sao_Paulo",
    "public": true,
    "logo": {
        "id": "7074908991469559808",
        "logo_small": "https:\/\/api.toornament.com\/toornament\/media\/file\/7074908991469559808\/logo_small",
        "logo_medium": "https:\/\/api.toornament.com\/toornament\/media\/file\/7074908991469559808\/logo_medium",
        "logo_large": "https:\/\/api.toornament.com\/toornament\/media\/file\/7074908991469559808\/logo_large",
        "original": "https:\/\/api.toornament.com\/toornament\/media\/file\/7074908991469559808\/original"
    },
    "background": {
        "id": "7074898466316419073",
        "small_4x1": "https:\/\/api.toornament.com\/toornament\/media\/file\/7074898466316419073\/small_4x1",
        "medium_4x1": "https:\/\/api.toornament.com\/toornament\/media\/file\/7074898466316419073\/medium_4x1",
        "full_4x1": "https:\/\/api.toornament.com\/toornament\/media\/file\/7074898466316419073\/full_4x1",
        "original": "https:\/\/api.toornament.com\/toornament\/media\/file\/7074898466316419073\/original"
    },
    "platforms": [
        "pc"
    ],
    "featured": true,
    "archived": false,
    "locales": {
        "en_GB": {
            "default": true
        },
        "fr": {
            "default": false
        }
    },
    "match_report_enabled": false,
    "registration_enabled": true,
    "registration_auto_accept_enabled": false,
    "registration_opening_datetime": "1999-01-01T00:00:00+00:00",
    "registration_closing_datetime": "1999-01-01T00:00:00+00:00",
    "registration_notification_enabled": true,
    "registration_participant_email_enabled": true,
    "registration_request_message": "For more info, go there -> []",
    "registration_acceptance_message": "You must now follow the next steps -> []",
    "registration_refusal_message": "Sorry, your registration has been refused.",
    "registration_terms_enabled": true,
    "registration_terms_url": "https:\/\/download.my\/terms.pdf",
    "registration_external_enabled": false,
    "registration_external_url": "https:\/\/esports.mywebsite.com\/event-registrations",
    "registration_permanent_team_mandatory": false,
    "registration_restrictions": {
        "age": {
            "enabled": true,
            "required": false,
            "min": 13,
            "max": null,
            "date_reference": "2015-09-06"
        },
        "country": {
            "enabled": true,
            "required": false,
            "allowed": [
                "DE"
            ]
        },
        "game_id": {
            "enabled": true,
            "required": false
        }
    },
    "check_in_enabled": true,
    "check_in_participant_enabled": true,
    "check_in_participant_start_datetime": "1999-01-01T00:00:00+00:00",
    "check_in_participant_end_datetime": "1999-01-01T00:00:00+00:00",
    "circuit": {
        "id": "5756452414364442624",
        "name": "Challenger League"
    },
    "circuit_season": {
        "id": "5756460443435106304",
        "name": "Season 42",
        "machine_name": "season_42"
    },
    "circuit_region": {
        "id": "5756460443435106304",
        "name": "Europe",
        "machine_name": "europe"
    },
    "circuit_tier": {
        "id": "5756492752630054912",
        "name": "Top",
        "machine_name": "top"
    }
}

Structure (object)

team_min_size
integer
The smallest possible team size (only if the tournament participant type is “team”).
Example: 2
team_max_size
integer
The largest possible team size (only if the tournament participant type is “team”).
Example: 5
id
string
The unique identifier of the tournament.
Example: "378426939508809728"
discipline
string
A unique identifier of the tournament’s discipline.
Example: "my_discipline"
name
string
The name of the tournament.
Max. length: 30 characters
Example: "My Weekly Tournament"
full_name
string|null
The complete name of the tournament.
Max. length: 80 characters
Example: "My Weekly Tournament - Long title"
description
string|null
A description of the tournament. Multilingual supported.
Max. length: 1,500 characters
Example: "My description\non multiple lines."
rules
string|null
The rules of the tournament. Multilingual supported.
Max. length: 64,000 characters
Example: "My rules\non multiple lines."
status
string
The status of the tournament.
Possible values: pending, running, completed
participant_type
string
The type of participants that play in the tournament.
Possible values: team, single
organization
string|null
The name of the organizer, be it an individual, group, association or company.
Max. length: 80 characters
Example: "Avery Bullock"
contact
string|null
The email address to contact the organizer.
Format: email
Max. length: 255 characters
Example: "[email protected]"
discord
string|null
Invite URL to the tournament Discord server.
Format: uri
Max. length: 255 characters
Example: "https://discord.gg/blablabla"
website
string|null
The tournament's official website URL.
Format: uri
Max. length: 255 characters
Example: "http://www.toornament.com"
online
boolean|null
Whether the tournament is played on internet or not.
Example: true
location
string|null
The region, city, address or place of interest where the tournament is held.
Max. length: 140 characters
Example: "London"
country
string|null
The country where the tournament is played. Some codes may not be supported. (format is ISO 3166-1 alpha-2)
Example: "GB"
size
integer
The expected number of participants in the tournament.
Example: 16
prize
string|null
The prizes of the tournament. Multilingual supported.
Max. length: 1,500 characters
Example: "1 - 10,000$\n2 - 5,000$"
scheduled_date_start
string|null
A starting date in ISO 8601 format (only the date part, with YYYY-MM-DD pattern).
Format: date
Example: "2015-09-06"
scheduled_date_end
string|null
An ending date in ISO 8601 format (only the date part, with YYYY-MM-DD pattern).
Format: date
Example: "2015-09-07"
timezone
string
A time zone from the IANA tz database. For more information, please read the Time Zones documentation.
Example: "America/Sao_Paulo"
public
boolean
Whether the tournament is published or not.
Example: true
logo
object|null
The tournament logo in every available format.
- id
  string
  The unique identifier of a file (with context "tournament_logo"), that can be used in other APIs.
  Example: "7074908991469559808"
- logo_small
  string
  URL of the small version of the tournament logo.
  Example: "https://api.toornament.com/toornament/media/file/7074908991469559808/logo_small"
- logo_medium
  string
  URL of the medium version of the tournament logo.
  Example: "https://api.toornament.com/toornament/media/file/7074908991469559808/logo_medium"
- logo_large
  string
  URL of the large version of the tournament logo.
  Example: "https://api.toornament.com/toornament/media/file/7074908991469559808/logo_large"
- original
  string
  URL of the original version of the tournament logo.
  Example: "https://api.toornament.com/toornament/media/file/7074908991469559808/original"
background
object|null
The tournament background in every available format (Pro plan).
- id
  string
  The unique identifier of a file (with context "tournament_background"), that can be used in other APIs.
  Example: "7074898466316419073"
- small_4x1
  string
  URL of the small version of the tournament background.
  Example: "https://api.toornament.com/toornament/media/file/7074898466316419073/small_4x1"
- medium_4x1
  string
  URL of the medium version of the tournament background.
  Example: "https://api.toornament.com/toornament/media/file/7074898466316419073/medium_4x1"
- full_4x1
  string
  URL of the full version of the tournament background.
  Example: "https://api.toornament.com/toornament/media/file/7074898466316419073/full_4x1"
- original
  string
  URL of the original version of the tournament background.
  Example: "https://api.toornament.com/toornament/media/file/7074898466316419073/original"
platforms
array[string]
The platform on which the tournament will be played.
Possible values: pc, playstation4, playstation5, xbox_one, xbox_series, nintendo_switch, nintendo_switch2, mobile, playstation3, xbox360, playstation2, playstation1, ps_vita, psp, xbox, wii_u, wii, gamecube, nintendo64, snes, nes, 3ds, ds, game_boy, dreamcast, saturn, megadrive, master_system, neo_geo, tabletop, other_platform, not_video_game
featured
boolean
Whether the tournament is featured or not.
Example: true
archived
boolean
Whether the tournament is archived or not.
Example: false
locales
object|null
The list of locales manages by this tournament. Accepts only locales "en_US", "en_GB" "de", "es", "fr", "pl", "pt_BR", "ar" and "id".
Example: {"en_GB":{"default":true},"fr":{"default":false}}
match_report_enabled
boolean
Whether the participant's match report is enabled or not.
Example: false
registration_enabled
boolean
Whether the registration process is enabled.
Example: true
registration_auto_accept_enabled
boolean
Whether to automatically accept new registrations in the tournament or not.
Example: false
registration_opening_datetime
string|null
The opening date of the registrations in RFC 3339 format (combined date, time and utc offset).
Format: datetime
Example: "1999-01-01T00:00:00+00:00"
registration_closing_datetime
string|null
The closing date of the registrations in RFC 3339 format (combined date, time and utc offset).
Format: datetime
Example: "1999-01-01T00:00:00+00:00"
registration_notification_enabled
boolean
Whether to notify organizers when new registrations occur or not.
Example: true
registration_participant_email_enabled
boolean
Whether to notify participants when they register to a tournament, and when their registration status changes.
Example: true
registration_request_message
string|null
The message provided by the organizer for people who want to register.
Max. length: 20,000 characters
Example: "For more info, go there -> []"
registration_acceptance_message
string|null
The message sent to a player when his registration is accepted.
Max. length: 20,000 characters
Example: "You must now follow the next steps -> []"
registration_refusal_message
string|null
The message sent to a player when his registration is refused.
Max. length: 20,000 characters
Example: "Sorry, your registration has been refused."
registration_terms_enabled
boolean
Whether custom 'terms of use' are required.
Example: true
registration_terms_url
string|null
If enabled, the URL of the custom 'terms of use'.
Format: uri
Max. length: 2,000 characters
Example: "https://download.my/terms.pdf"
registration_external_enabled
boolean
Whether another website used for registration process.
Example: false
registration_external_url
string|null
If enabled, the official registration page will redirect on external URL.
Format: uri
Max. length: 2,000 characters
Example: "https://esports.mywebsite.com/event-registrations"
registration_permanent_team_mandatory
boolean
Whether registration only allow permanent team.
Example: false
registration_restrictions
object
The tournament registration restriction settings.
- age
  object
  The tournament registration restriction about player-user birthdate.
  - enabled
    boolean
    Whether the tournament registration restriction age is enabled.
    Example: true
  - required
    boolean
    Whether the player-user birthdate is required in the registration.
    Example: false
  - min
    integer|null
    Minimal age (calculate from the date reference) of a player-user in the registration.
    Example: 13
  - max
    integer|null
    Maximal age (calculate from the date reference) of a player-user in the registration.
  - date_reference
    string|null
    An ISO 8601 date (only the date part, with YYYY-MM-DD pattern) used to calculate the age of player-user in the registration. We recommend using the date of the start of the tournament.
    Format: date
    Example: "2015-09-06"
- country
  object
  The tournament registration restriction about player-user country.
  - enabled
    boolean
    Whether the tournament registration restriction country is enabled.
    Example: true
  - required
    boolean
    Whether the player-user country is required in the registration.
    Example: false
  - allowed
    array[string]|null
    List of the countries, with format ISO 3166-1 alpha-2 country codes.
    Example: ["DE"]
- game_id
  object
  The tournament registration restriction about player-user game identifier.
  - enabled
    boolean
    Whether the tournament registration restriction game identifier is enabled. Always true if game integration is enabled in the tournament.
    Example: true
  - required
    boolean
    Whether the player-user game identifier is required in the registration. Always true if game integration is enabled in the tournament.
    Example: false
check_in_enabled
boolean
Whether to enable the check-in or not.
Example: true
check_in_participant_enabled
boolean
Whether to enable the check-in for participants or not.
Example: true
check_in_participant_start_datetime
string|null
The date and time of the start of the participant check-in, in RFC 3339 format (combined date, time and utc offset).
Format: datetime
Example: "1999-01-01T00:00:00+00:00"
check_in_participant_end_datetime
string|null
The date and time of the end of the participant check-in, in RFC 3339 format (combined date, time and utc offset).
Format: datetime
Example: "1999-01-01T00:00:00+00:00"
circuit
object|null
The circuit associated with this tournament.
- id
  string
  The id of the circuit.
  Example: "5756452414364442624"
- name
  string
  The name of the circuit.
  Max. length: 40 characters
  Example: "Challenger League"
circuit_season
object|null
The circuit season associated with this tournament.
- id
  string
  The id of the circuit season.
  Example: "5756460443435106304"
- name
  string
  The name of the circuit season.
  Max. length: 40 characters
  Example: "Season 42"
- machine_name
  string
  A name used to identify a circuit season.
  Pattern: ^[a-z0-9_]+$
  Max. length: 40 characters
  Example: "season_42"
circuit_region
object|null
The circuit region associated with this tournament.
- id
  string
  The id of the circuit region.
  Example: "5756460443435106304"
- name
  string
  The name of the circuit region.
  Max. length: 40 characters
  Example: "Europe"
- machine_name
  string
  A name used to identify a circuit region.
  Pattern: ^[a-z0-9_]+$
  Max. length: 40 characters
  Example: "europe"
circuit_tier
object|null
The circuit tier associated with this tournament.
- id
  string
  The id of the circuit tier.
  Example: "5756492752630054912"
- name
  string
  The name of the circuit tier.
  Max. length: 40 characters
  Example: "Top"
- machine_name
  string
  A name used to identify a circuit tier.
  Pattern: ^[a-z0-9_]+$
  Max. length: 40 characters
  Example: "top"

DELETE /tournaments/{id}

Deletes your tournament identified by the given id.

Resource URL

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

HTTP headers

X-Api-Key
string
API key of your application (see Authentication)
Authorization
string
Access token with organizer:delete scope (see Authorization)

Path parameters

id
string
The id of the tournament.

Query Parameters

This endpoint does not have any query parameters.

Request Body

This endpoint does not require a request body.

Endpoints

GET /tournaments

Resource URL

HTTP headers

Query Parameters

Request Body

Response

[206] Tournaments retrieved.

Example

Structure (collection)

POST /tournaments

Resource URL

HTTP headers

Query Parameters

Request Body

Tournament data

Example

Structure (object)

Response

[201] Tournament created.

Example

Structure (object)

GET /tournaments/{id}

Resource URL

HTTP headers

Path parameters

Query Parameters

Request Body

Response

[200] Tournament retrieved.

Example

Structure (object)

PATCH /tournaments/{id}

Resource URL

HTTP headers

Path parameters

Query Parameters

Request Body

Tournament data.

Example

Structure (object)

Response

[200] Success.

Example

Structure (object)

DELETE /tournaments/{id}

Resource URL

HTTP headers

Path parameters

Query Parameters

Request Body

Response

[204] Success.