Participants

GET /me/participants

Authorized Access

Returns the participants linked to the user associated to the access token.

Resource URL

https://api.toornament.com/participant/v2/me/participants

HTTP headers

  • X-Api-Key
    string

    API key of your application (see Authentication)

  • Authorization
    string

    Access token with participant:manage_participations scope (see Authorization)

  • Range
    string

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

    Example: participants=0-49

Query Parameters

  • tournament_ids
    array

    Only return participants for the given list of tournaments.

    Example: 378426939508809728,534138941862841533

  • playlist_ids
    array

    Only return participants for the tournaments listed in the playlist.

    Example: 123485236848698874,135864989139387313

Request Body

This endpoint does not require a request body.

Response

[206] Participants retrieved.

Example
[
    {
        "id": "375143143408309123",
        "tournament_id": "378426939508809728",
        "type": "team",
        "name": "Northmen",
        "custom_fields": {},
        "checked_in": true,
        "checked_in_at": "2015-12-32T13:37:42+00:00",
        "lineup": [
            {
                "name": "Jon Snow",
                "email": "player_1@team.com",
                "custom_fields": {}
            }
        ]
    }
]
Structure (collection)
  • id
    string

    The id of the participant.

    Example: "375143143408309123"

  • tournament_id
    string

    The id of the tournament that contains this participant.

    Example: "378426939508809728"

  • type
    string

    The type of participants that play in the tournament.

    Possible values: team, player

  • name
    string

    The name of the participant.

    Max. length: 40 characters

    Example: "Northmen"

  • custom_fields
    object

    The values of the custom fields configured in the tournament using the machine names as keys. For more information, please read the Custom Fields documentation.

    Example: {}

  • checked_in
    boolean

    Whether the participant is checked in.

    Example: true

  • checked_in_at
    string|null

    The date and time of the participant check-in, in RFC 3339 format (combined date, time and utc offset).

    Format: datetime

    Example: "2015-12-32T13:37:42+00:00"

  • lineup
    array[object]

    A list of players in a team (Only if the tournament participant type is “team”).

GET /me/participants/{id}

Authorized Access

Returns the participant with the given id on the condition that it is associated to the authenticated user, else the endpoint will return a 403 Error (Forbidden).

Resource URL

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

HTTP headers

  • X-Api-Key
    string

    API key of your application (see Authentication)

  • Authorization
    string

    Access token with participant:manage_participations scope (see Authorization)

Path parameters

  • id
    string

    The id of the participant to retrieve.

Query Parameters

This endpoint does not have any query parameters.

Request Body

This endpoint does not require a request body.

Response

[200] Participant retrieved.

Example
{
    "id": "375143143408309123",
    "tournament_id": "378426939508809728",
    "type": "team",
    "name": "Northmen",
    "custom_fields": {},
    "checked_in": true,
    "checked_in_at": "2015-12-32T13:37:42+00:00",
    "lineup": [
        {
            "name": "Jon Snow",
            "email": "player_1@team.com",
            "custom_fields": {}
        }
    ]
}
Structure (object)
  • id
    string

    The id of the participant.

    Example: "375143143408309123"

  • tournament_id
    string

    The id of the tournament that contains this participant.

    Example: "378426939508809728"

  • type
    string

    The type of participants that play in the tournament.

    Possible values: team, player

  • name
    string

    The name of the participant.

    Max. length: 40 characters

    Example: "Northmen"

  • custom_fields
    object

    The values of the custom fields configured in the tournament using the machine names as keys. For more information, please read the Custom Fields documentation.

    Example: {}

  • checked_in
    boolean

    Whether the participant is checked in.

    Example: true

  • checked_in_at
    string|null

    The date and time of the participant check-in, in RFC 3339 format (combined date, time and utc offset).

    Format: datetime

    Example: "2015-12-32T13:37:42+00:00"

  • lineup
    array[object]

    A list of players in a team (Only if the tournament participant type is “team”).

PATCH /me/participants/{id}

Authorized Access

Updates the participant with the given id on the condition that it is associated to the authenticated user, else the endpoint will return a 403 Error (Forbidden).

Resource URL

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

HTTP headers

  • X-Api-Key
    string

    API key of your application (see Authentication)

  • Authorization
    string

    Access token with participant:manage_participations scope (see Authorization)

Path parameters

  • id
    string

    The id of the participant to retrieve.

Query Parameters

This endpoint does not have any query parameters.

Request Body

Participant data.

Example
{
    "checked_in": true
}
Structure (object)
  • checked_in
    boolean

    Optional

    If you confirm the check-in, you will not be able to go back.

    Example: true

Response

[200] Participant update.

Example
{
    "id": "375143143408309123",
    "tournament_id": "378426939508809728",
    "type": "team",
    "name": "Northmen",
    "custom_fields": {},
    "checked_in": true,
    "checked_in_at": "2015-12-32T13:37:42+00:00",
    "lineup": [
        {
            "name": "Jon Snow",
            "email": "player_1@team.com",
            "custom_fields": {}
        }
    ]
}
Structure (object)
  • id
    string

    The id of the participant.

    Example: "375143143408309123"

  • tournament_id
    string

    The id of the tournament that contains this participant.

    Example: "378426939508809728"

  • type
    string

    The type of participants that play in the tournament.

    Possible values: team, player

  • name
    string

    The name of the participant.

    Max. length: 40 characters

    Example: "Northmen"

  • custom_fields
    object

    The values of the custom fields configured in the tournament using the machine names as keys. For more information, please read the Custom Fields documentation.

    Example: {}

  • checked_in
    boolean

    Whether the participant is checked in.

    Example: true

  • checked_in_at
    string|null

    The date and time of the participant check-in, in RFC 3339 format (combined date, time and utc offset).

    Format: datetime

    Example: "2015-12-32T13:37:42+00:00"

  • lineup
    array[object]

    A list of players in a team (Only if the tournament participant type is “team”).