Participant API › Tournaments Legacy

Endpoints

LegacyGET /tournaments/{id}
Retrieve a single tournament, with its information and configuration settings.

LegacyGET /tournaments/{id}

This endpoint is in legacy mode. Access will soon be deprecated. It is therefore advised to use another endpoint when possible.

Returns a tournament with its information and complete settings (registration, check-in, match reporting etc.).

Resource URL

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

HTTP headers

X-Api-Key
string
API key of your application (see Authentication)

Path parameters

id
string
The id of the tournament to retrieve.

Query Parameters

This endpoint does not have any query parameters.

Request Body

This endpoint does not require a request body.

Response

[200] Tournament 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",
        "playstation4"
    ],
    "logo": {
        "logo_small": "https:\/\/www.toornament.com\/media\/file\/123456\/logo_small",
        "logo_medium": "https:\/\/www.toornament.com\/media\/file\/123456\/logo_medium",
        "logo_large": "https:\/\/www.toornament.com\/media\/file\/123456\/logo_large",
        "original": "https:\/\/www.toornament.com\/media\/file\/123456\/original"
    },
    "participant_type": "single",
    "organization": "Avery Bullock",
    "contact": "[email protected]",
    "discord": "https:\/\/discord.gg\/blablabla",
    "website": "http:\/\/www.toornament.com",
    "description": "My description \\n on multiple lines",
    "rules": "My rules \\n on multiple lines",
    "prize": "1 - 10,000$ \\n 2 - 5,000$",
    "registration_enabled": true,
    "registration_opening_datetime": "1999-01-01T00:00:00+00:00",
    "registration_closing_datetime": "1999-01-01T00:00:00+00:00",
    "match_report_enabled": false,
    "registration_request_message": "For more info, go there -> []",
    "registration_user_mailer_enabled": true,
    "registration_terms_enabled": true,
    "registration_terms_url": "http:\/\/download.my\/terms.pdf",
    "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",
    "team_min_size": 2,
    "team_max_size": 5
}

Structure (object)

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
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
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.
Example: "America/Sao_Paulo"
public
boolean
Whether the tournament is published.
Example: true
size
integer
The expected number of participants in the tournament.
Example: 16
online
boolean|null
Whether the tournament is played on internet.
Example: true
location
string|null
The region, city, address or place of interest where the tournament is held.
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]
A list of platforms on which the tournament can be played.
Possible values: pc, playstation4, xbox_one, nintendo_switch, 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
logo
object
- logo_small
  string
  URL of the small version of the tournament logo.
  Example: "https://www.toornament.com/media/file/123456/logo_small"
- logo_medium
  string
  URL of the medium version of the tournament logo.
  Example: "https://www.toornament.com/media/file/123456/logo_medium"
- logo_large
  string
  URL of the large version of the tournament logo.
  Example: "https://www.toornament.com/media/file/123456/logo_large"
- original
  string
  URL of the original version of the tournament logo.
  Example: "https://www.toornament.com/media/file/123456/original"
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"
description
string|null
A description of the tournament.
Max. length: 1,500 characters
Example: "My description \n on multiple lines"
rules
string|null
The rules of the tournament.
Max. length: 10,000 characters
Example: "My rules \n on multiple lines"
prize
string|null
The prizes of the tournament.
Max. length: 1,500 characters
Example: "1 - 10,000$ \n 2 - 5,000$"
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"
match_report_enabled
boolean
Whether the participant's match report is enabled.
Example: false
registration_request_message
string|null
The message provided by the organizer for people who want to register.
Example: "For more info, go there -> []"
registration_user_mailer_enabled
boolean
Whether to notify participants when their registration status changes.
Example: true
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'.
Example: "http://download.my/terms.pdf"
check_in_enabled
boolean
Whether to enable the check-in.
Example: true
check_in_participant_enabled
boolean
Whether to enable the check-in for participants.
Example: true
check_in_participant_start_datetime
string|null
The date and time of the participant check-in start, 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 participant check-in start, in RFC 3339 format (combined date, time and utc offset).
Format: datetime
Example: "1999-01-01T00:00:00+00:00"
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