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

    Example: participants=0-49

Path parameters

  • tournament_id
    string

    The id of the tournament containing the participants

Query Parameters

  • name
    string

    The string to be looked for in the name.

  • sort
    string

    A method to sort the filtered data. created_asc and created_desc sorts using the date the participant was added. alphabetic sorts using an case-insensitive participant name.

    Possible values: created_asc, created_desc, alphabetic

    Default: created_asc

Request Body

This endpoint doesn't require a request body.

Response

[206] Participants retrieved

Example
[
    {
        "id": "375143143408309123",
        "name": "Northmen",
        "custom_fields": {
            "twitter": "my_twitter_id",
            "country": "UK",
            "logo": {
                "logo_small": "url_to_small_image",
                "logo_medium": "url_to_medium_image",
                "logo_large": "url_to_large_image"
            }
        },
        "lineup": [
            {
                "name": "Jon Snow",
                "custom_fields": {
                    "twitter": "my_twitter_id",
                    "country": "UK",
                    "logo": {
                        "logo_small": "url_to_small_image",
                        "logo_medium": "url_to_medium_image",
                        "logo_large": "url_to_large_image"
                    }
                }
            }
        ]
    }
]
Structure (collection)
  • id
    string

    The id of the participant

    Example: "375143143408309123"

  • name
    string

    The participant name (maximum 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.

  • lineup
    array[object]

    teams only

    A list of team players

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

Simple Access

Returns a participant identified by 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 containing the participant

  • id
    string

    The id 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] Participant retrieved

Example
[
    {
        "id": "375143143408309123",
        "name": "Northmen",
        "custom_fields": {
            "twitter": "my_twitter_id",
            "country": "UK",
            "logo": {
                "logo_small": "url_to_small_image",
                "logo_medium": "url_to_medium_image",
                "logo_large": "url_to_large_image"
            }
        },
        "lineup": [
            {
                "name": "Jon Snow",
                "custom_fields": {
                    "twitter": "my_twitter_id",
                    "country": "UK",
                    "logo": {
                        "logo_small": "url_to_small_image",
                        "logo_medium": "url_to_medium_image",
                        "logo_large": "url_to_large_image"
                    }
                }
            }
        ]
    }
]
Structure (collection)
  • id
    string

    The id of the participant

    Example: "375143143408309123"

  • name
    string

    The participant name (maximum 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.

  • lineup
    array[object]

    teams only

    A list of team players