Participants

GET /tournaments/{tournament_id}/participants

Simple Access

Returns the participants of the given tournament. The data provided in the participant depends on whether the participant type is team or player. This setting can be found in the tournament.

Resource URL

https://api.toornament.com/viewer/v2/tournaments/{tournament_id}/participants

HTTP headers

  • X-Api-Key
    string

    API key of your application (see Authentication)

  • 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

Path parameters

  • tournament_id
    string

    The id of the tournament the participants are from.

Query Parameters

  • name
    string

    The string to be looked for in the name of the participant.

  • sort
    string

    A method to sort the filtered data. “created_asc” and “created_desc” sort the participants from their creation date (earliest to latest, and inversely). “Alphabetic” sorts the participants using their case-insensitive names.

    Possible values: created_asc, created_desc, alphabetic

    Default: created_asc

Request Body

This endpoint does not require a request body.

Response

[206] Participants retrieved.

Example
[
    {
        "id": "375143143408309123",
        "name": "Northmen",
        "custom_fields": {},
        "lineup": [
            {
                "name": "Jon Snow",
                "custom_fields": {}
            }
        ]
    }
]
Structure (collection)
  • id
    string

    The id of the participant.

    Example: "375143143408309123"

  • name
    string

    The name of the participant.

    Max. length: 40 characters

    Example: "Northmen"

  • custom_fields
    object

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

    Example: {}

  • lineup
    array[object]

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

GET /tournaments/{tournament_id}/participants/{id}

Simple Access

Returns a participant identified with the given id. The data provided in the participant depends on whether the participant type is team or player. This setting can be found in the tournament.

Resource URL

https://api.toornament.com/viewer/v2/tournaments/{tournament_id}/participants/{id}

HTTP headers

Path parameters

  • tournament_id
    string

    The id of the tournament the participants are from.

  • 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",
    "name": "Northmen",
    "custom_fields": {},
    "lineup": [
        {
            "name": "Jon Snow",
            "custom_fields": {}
        }
    ]
}
Structure (object)
  • id
    string

    The id of the participant.

    Example: "375143143408309123"

  • name
    string

    The name of the participant.

    Max. length: 40 characters

    Example: "Northmen"

  • custom_fields
    object

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

    Example: {}

  • lineup
    array[object]

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