Participants

GET /me/participants

Authorized Access

Returns the participants of 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 cannot exceed 50. (see Pagination)

    Example: participants=0-49

Query Parameters

  • tournament_ids
    string

    Only return participants for the given list of tournaments.

    Example: 378426939508809728,534138941862841533

  • playlist_ids
    string

    Only return participants for the tournaments listed in the playlist.

    Example: 123485236848698874,135864989139387313

Request Body

This endpoint doesn't require a request body.

Response

[206] Participants retrieved

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

    A unique identifier for this participant.

    Example: "375143143408309123"

  • tournament_id
    string

    The id of the tournament that contains this participant.

    Example: "378426939508809728"

  • type
    string

    The type of participants who plays in the tournament.

    Possible values: team, player

  • name
    string

    A name (maximum 40 characters).

    Example: "A team or player name"

  • 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.

  • lineup
    array[object]

    Optional

    A list of team players.

  • checked_in
    boolean

    Whether the participant is check-in.

    Example: true

  • checked_in_at
    datetime|null

    The datetime of check-in of the participant.

    Format: RFC 3339 (combined date, time and utc offset)

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

GET /me/participants/{id}

Authorized Access

Returns a participant by the given id and user associated to the access token. If the participant does not exist or is not associated to the user, the endpoint will return a 404 (Not Found).

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 unique identifier of the participant to retrieve

Query Parameters

This endpoint doesn't have any query parameters.

Request Body

This endpoint doesn't require a request body.

Response

[200] Registration retrieved

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

    A unique identifier for this participant.

    Example: "375143143408309123"

  • tournament_id
    string

    The id of the tournament that contains this participant.

    Example: "378426939508809728"

  • type
    string

    The type of participants who plays in the tournament.

    Possible values: team, player

  • name
    string

    A name (maximum 40 characters).

    Example: "A team or player name"

  • 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.

  • lineup
    array[object]

    Optional

    A list of team players.

  • checked_in
    boolean

    Whether the participant is check-in.

    Example: true

  • checked_in_at
    datetime|null

    The datetime of check-in of the participant.

    Format: RFC 3339 (combined date, time and utc offset)

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

PATCH /me/participants/{id}

Authorized Access

Updates one participant by the given id and user associated to the access token.

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 doesn't 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": "A team or player name",
    "custom_fields": {
        "country": "GB",
        "twitter": "twitter_id"
    },
    "lineup": [
        {
            "name": "A team player name",
            "email": "player_1@team.com",
            "custom_fields": {
                "country": "GB",
                "twitter": "twitter_id"
            }
        }
    ],
    "checked_in": true,
    "checked_in_at": "2015-12-32T13:37:42+00:00"
}
Structure (object)
  • id
    string

    A unique identifier for this participant.

    Example: "375143143408309123"

  • tournament_id
    string

    The id of the tournament that contains this participant.

    Example: "378426939508809728"

  • type
    string

    The type of participants who plays in the tournament.

    Possible values: team, player

  • name
    string

    A name (maximum 40 characters).

    Example: "A team or player name"

  • 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.

  • lineup
    array[object]

    Optional

    A list of team players.

  • checked_in
    boolean

    Whether the participant is check-in.

    Example: true

  • checked_in_at
    datetime|null

    The datetime of check-in of the participant.

    Format: RFC 3339 (combined date, time and utc offset)

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