Participants (JD2017)

Endpoints

GET /tournaments/{tournament_id}/participants

Authorized 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/organizer/v2/tournaments/{tournament_id}/participants

HTTP headers

  • X-Api-Key
    string

    API key of your application (see Authentication)

  • Authorization
    string

    Access token with organizer:participant 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

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": "Jon Snow",
        "email": "jonanddaenerys@westeros.got",
        "user_id": "145246939508809147",
        "custom_user_identifier": "acme:account:1234",
        "checked_in": true,
        "custom_fields": {
            "twitter": "my_twitter_id",
            "country": "GB",
            "logo": {
                "logo_small": "url_to_small_image",
                "logo_medium": "url_to_medium_image",
                "logo_large": "url_to_large_image"
            }
        },
        "lineup": [
            {
                "name": "Baby Water",
                "email": "babyofjonanddaenerys@westeros.got",
                "user_id": "169878948648684781",
                "custom_user_identifier": "acme:account:1234",
                "custom_fields": {
                    "twitter": "my_twitter_id",
                    "country": "GB",
                    "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: "Jon Snow"

  • email
    string

    The participant email (maximum 254 characters)

    Example: "jonanddaenerys@westeros.got"

  • user_id
    string|null

    The identifier of user associate to this participant

    Example: "145246939508809147"

  • custom_user_identifier
    string|null

    An external user identifier, use the format that suits you best

    Example: "acme:account:1234"

  • checked_in
    boolean

    Whether the participant is check-in

    Example: true

  • 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

POST /tournaments/{tournament_id}/participants

Authorized Access

Create a participant in a tournament.

Resource URL

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

HTTP headers

  • X-Api-Key
    string

    API key of your application (see Authentication)

  • Authorization
    string

    Access token with organizer:participant scope (see Authorization)

Path parameters

  • tournament_id
    string

    The id of the tournament containing the participant

Query Parameters

This endpoint doesn't have any query parameters.

Request Body

Create a participant

Example
{
    "name": "Jon Snow",
    "email": "jonanddaenerys@westeros.got",
    "custom_user_identifier": "acme:account:1234",
    "checked_in": true,
    "custom_fields": {
        "twitter": "my_twitter_id",
        "country": "GB"
    },
    "lineup": [
        {
            "name": "Baby Water",
            "custom_user_identifier": "acme:account:1234",
            "email": "babyofjonanddaenerys@westeros.got",
            "custom_fields": {
                "twitter": "my_twitter_id",
                "country": "GB"
            }
        }
    ]
}
Structure (object)
  • name
    string

    The participant name (maximum 40 characters)

    Example: "Jon Snow"

  • email
    string

    Optional

    The participant email (maximum 254 characters)

    Example: "jonanddaenerys@westeros.got"

  • custom_user_identifier
    string|null

    Optional

    An external user identifier, use the format that suits you best

    Example: "acme:account:1234"

  • checked_in
    boolean

    Optional

    Whether the participant is check-in

    Example: true

  • custom_fields
    object

    Optional

    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]

    Optionalteams only

    A list of team players

Response

[201] Success

Example
{
    "id": "375143143408309123",
    "email": "jonanddaenerys@westeros.got",
    "name": "Jon Snow",
    "user_id": "145246939508809147",
    "custom_user_identifier": "acme:account:1234",
    "checked_in": true,
    "checked_in_at": "2015-12-32T13:37:42+00:00",
    "custom_fields": {
        "twitter": "my_twitter_id",
        "country": "GB",
        "logo": {
            "logo_small": "url_to_small_image",
            "logo_medium": "url_to_medium_image",
            "logo_large": "url_to_large_image"
        }
    },
    "lineup": [
        {
            "name": "Baby Water",
            "email": "babyofjonanddaenerys@westeros.got",
            "user_id": "169878948648684781",
            "custom_user_identifier": "acme:account:1234",
            "custom_fields": {
                "twitter": "my_twitter_id",
                "country": "GB",
                "logo": {
                    "logo_small": "url_to_small_image",
                    "logo_medium": "url_to_medium_image",
                    "logo_large": "url_to_large_image"
                }
            }
        }
    ]
}
Structure (object)
  • id
    string

    The id of the participant

    Example: "375143143408309123"

  • email
    string

    The participant email (maximum 254 characters)

    Example: "jonanddaenerys@westeros.got"

  • name
    string

    The participant name (maximum 40 characters)

    Example: "Jon Snow"

  • user_id
    string|null

    The identifier of user associate to this participant

    Example: "145246939508809147"

  • custom_user_identifier
    string|null

    An external user identifier, use the format that suits you best

    Example: "acme:account:1234"

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

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

Authorized 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/organizer/v2/tournaments/{tournament_id}/participants/{id}

HTTP headers

  • X-Api-Key
    string

    API key of your application (see Authentication)

  • Authorization
    string

    Access token with organizer:participant scope (see Authorization)

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",
    "email": "jonanddaenerys@westeros.got",
    "name": "Jon Snow",
    "user_id": "145246939508809147",
    "custom_user_identifier": "acme:account:1234",
    "checked_in": true,
    "checked_in_at": "2015-12-32T13:37:42+00:00",
    "custom_fields": {
        "twitter": "my_twitter_id",
        "country": "GB",
        "logo": {
            "logo_small": "url_to_small_image",
            "logo_medium": "url_to_medium_image",
            "logo_large": "url_to_large_image"
        }
    },
    "lineup": [
        {
            "name": "Baby Water",
            "email": "babyofjonanddaenerys@westeros.got",
            "user_id": "169878948648684781",
            "custom_user_identifier": "acme:account:1234",
            "custom_fields": {
                "twitter": "my_twitter_id",
                "country": "GB",
                "logo": {
                    "logo_small": "url_to_small_image",
                    "logo_medium": "url_to_medium_image",
                    "logo_large": "url_to_large_image"
                }
            }
        }
    ]
}
Structure (object)
  • id
    string

    The id of the participant

    Example: "375143143408309123"

  • email
    string

    The participant email (maximum 254 characters)

    Example: "jonanddaenerys@westeros.got"

  • name
    string

    The participant name (maximum 40 characters)

    Example: "Jon Snow"

  • user_id
    string|null

    The identifier of user associate to this participant

    Example: "145246939508809147"

  • custom_user_identifier
    string|null

    An external user identifier, use the format that suits you best

    Example: "acme:account:1234"

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

  • 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

PATCH /tournaments/{tournament_id}/participants/{id}

Authorized Access

Updates one participant

Resource URL

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

HTTP headers

  • X-Api-Key
    string

    API key of your application (see Authentication)

  • Authorization
    string

    Access token with organizer:participant scope (see Authorization)

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

Participant data

Example
{
    "name": "Jon Snow",
    "email": "jonanddaenerys@westeros.got",
    "custom_user_identifier": "acme:account:1234",
    "checked_in": true,
    "custom_fields": {
        "twitter": "my_twitter_id",
        "country": "GB"
    },
    "lineup": [
        {
            "name": "Baby Water",
            "custom_user_identifier": "acme:account:1234",
            "email": "babyofjonanddaenerys@westeros.got",
            "custom_fields": {
                "twitter": "my_twitter_id",
                "country": "GB"
            }
        }
    ]
}
Structure (object)
  • name
    string

    Optional

    The participant name (maximum 40 characters)

    Example: "Jon Snow"

  • email
    string

    Optional

    The participant email (maximum 254 characters)

    Example: "jonanddaenerys@westeros.got"

  • custom_user_identifier
    string|null

    Optional

    An external user identifier, use the format that suits you best

    Example: "acme:account:1234"

  • checked_in
    boolean

    Optional

    Whether the participant is check-in

    Example: true

  • custom_fields
    object

    Optional

    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]

    Optionalteams only

    A list of team players

Response

[200] Participant update

Example
{
    "id": "375143143408309123",
    "email": "jonanddaenerys@westeros.got",
    "name": "Jon Snow",
    "user_id": "145246939508809147",
    "custom_user_identifier": "acme:account:1234",
    "checked_in": true,
    "checked_in_at": "2015-12-32T13:37:42+00:00",
    "custom_fields": {
        "twitter": "my_twitter_id",
        "country": "GB",
        "logo": {
            "logo_small": "url_to_small_image",
            "logo_medium": "url_to_medium_image",
            "logo_large": "url_to_large_image"
        }
    },
    "lineup": [
        {
            "name": "Baby Water",
            "email": "babyofjonanddaenerys@westeros.got",
            "user_id": "169878948648684781",
            "custom_user_identifier": "acme:account:1234",
            "custom_fields": {
                "twitter": "my_twitter_id",
                "country": "GB",
                "logo": {
                    "logo_small": "url_to_small_image",
                    "logo_medium": "url_to_medium_image",
                    "logo_large": "url_to_large_image"
                }
            }
        }
    ]
}
Structure (object)
  • id
    string

    The id of the participant

    Example: "375143143408309123"

  • email
    string

    The participant email (maximum 254 characters)

    Example: "jonanddaenerys@westeros.got"

  • name
    string

    The participant name (maximum 40 characters)

    Example: "Jon Snow"

  • user_id
    string|null

    The identifier of user associate to this participant

    Example: "145246939508809147"

  • custom_user_identifier
    string|null

    An external user identifier, use the format that suits you best

    Example: "acme:account:1234"

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

  • 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

DELETE /tournaments/{tournament_id}/participants/{id}

Authorized Access

Deletes one participant.

Resource URL

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

HTTP headers

  • X-Api-Key
    string

    API key of your application (see Authentication)

  • Authorization
    string

    Access token with organizer:participant scope (see Authorization)

Path parameters

  • tournament_id
    string

    A unique identifier of the tournament.

  • id
    string

    The id of the requested participant.

Query Parameters

This endpoint doesn't have any query parameters.

Request Body

This endpoint doesn't require a request body.

Response

[204] Success