Participants

GET /tournaments/{tournament_id}/participants

Authorized Access

Returns the participants of the given tournament. The participant data 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 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
[
    {
        "name": "Jon Snow",
        "email": "jonanddaenerys@westeros.got\"",
        "custom_user_identifier": "acme:account:1234",
        "checked_in": true,
        "custom_fields": {},
        "id": "375143143408309123",
        "user_id": "145246939508809147",
        "lineup": [
            {
                "name": "Jon Snow",
                "custom_user_identifier": "acme:account:1234",
                "email": "jonanddaenerys@westeros.got\"",
                "custom_fields": {},
                "user_id": "145246939508809147"
            }
        ]
    }
]
Structure (collection)
  • name
    string

    The name of the participant.

    Max. length: 40 characters

    Example: "Jon Snow"

  • email
    string

    The participant email.

    Max. length: 254 characters

    Example: "jonanddaenerys@westeros.got""

  • custom_user_identifier
    string|null

    An external custom user identifier. Use the format that suits your needs.

    Max. length: 100 characters

    Example: "acme:account:1234"

  • checked_in
    boolean

    Whether the participant is checked 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.

    Example: {}

  • id
    string

    The id of the participant.

    Example: "375143143408309123"

  • user_id
    string|null

    The identifier of user associate to this participant.

    Example: "145246939508809147"

  • lineup
    array[object]

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

POST /tournaments/{tournament_id}/participants

Authorized Access

Create a new participant in the given 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 the participants are from.

Query Parameters

This endpoint does not 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": {},
    "lineup": [
        {
            "name": "Jon Snow",
            "custom_user_identifier": "acme:account:1234",
            "email": "jonanddaenerys@westeros.got\"",
            "custom_fields": {}
        }
    ]
}
Structure (object)
  • name
    string

    The name of the participant.

    Max. length: 40 characters

    Example: "Jon Snow"

  • email
    string

    Optional

    The participant email.

    Max. length: 254 characters

    Example: "jonanddaenerys@westeros.got""

  • custom_user_identifier
    string|null

    Optional

    An external custom user identifier. Use the format that suits your needs.

    Max. length: 100 characters

    Example: "acme:account:1234"

  • checked_in
    boolean

    Optional

    Whether the participant is checked 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.

    Example: {}

  • lineup
    array[object]

    Optional

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

Response

[201] Success

Example
{
    "name": "Jon Snow",
    "email": "jonanddaenerys@westeros.got\"",
    "custom_user_identifier": "acme:account:1234",
    "checked_in": true,
    "custom_fields": {},
    "id": "375143143408309123",
    "user_id": "145246939508809147",
    "checked_in_at": "2015-12-32T13:37:42+00:00",
    "lineup": [
        {
            "name": "Jon Snow",
            "custom_user_identifier": "acme:account:1234",
            "email": "jonanddaenerys@westeros.got\"",
            "custom_fields": {},
            "user_id": "145246939508809147"
        }
    ]
}
Structure (object)
  • name
    string

    The name of the participant.

    Max. length: 40 characters

    Example: "Jon Snow"

  • email
    string

    The participant email.

    Max. length: 254 characters

    Example: "jonanddaenerys@westeros.got""

  • custom_user_identifier
    string|null

    An external custom user identifier. Use the format that suits your needs.

    Max. length: 100 characters

    Example: "acme:account:1234"

  • checked_in
    boolean

    Whether the participant is checked 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.

    Example: {}

  • id
    string

    The id of the participant.

    Example: "375143143408309123"

  • user_id
    string|null

    The identifier of user associate to this participant.

    Example: "145246939508809147"

  • 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 /tournaments/{tournament_id}/participants/{id}

Authorized Access

Returns a single participant of the given tournament. The participant data 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 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
{
    "name": "Jon Snow",
    "email": "jonanddaenerys@westeros.got\"",
    "custom_user_identifier": "acme:account:1234",
    "checked_in": true,
    "custom_fields": {},
    "id": "375143143408309123",
    "user_id": "145246939508809147",
    "checked_in_at": "2015-12-32T13:37:42+00:00",
    "lineup": [
        {
            "name": "Jon Snow",
            "custom_user_identifier": "acme:account:1234",
            "email": "jonanddaenerys@westeros.got\"",
            "custom_fields": {},
            "user_id": "145246939508809147"
        }
    ]
}
Structure (object)
  • name
    string

    The name of the participant.

    Max. length: 40 characters

    Example: "Jon Snow"

  • email
    string

    The participant email.

    Max. length: 254 characters

    Example: "jonanddaenerys@westeros.got""

  • custom_user_identifier
    string|null

    An external custom user identifier. Use the format that suits your needs.

    Max. length: 100 characters

    Example: "acme:account:1234"

  • checked_in
    boolean

    Whether the participant is checked 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.

    Example: {}

  • id
    string

    The id of the participant.

    Example: "375143143408309123"

  • user_id
    string|null

    The identifier of user associate to this participant.

    Example: "145246939508809147"

  • 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 /tournaments/{tournament_id}/participants/{id}

Authorized Access

Updates a single participant of the given tournament. The participant data 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 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

Participant data.

Example
{
    "name": "Jon Snow",
    "email": "jonanddaenerys@westeros.got\"",
    "custom_user_identifier": "acme:account:1234",
    "checked_in": true,
    "custom_fields": {},
    "lineup": [
        {
            "name": "Jon Snow",
            "custom_user_identifier": "acme:account:1234",
            "email": "jonanddaenerys@westeros.got\"",
            "custom_fields": {}
        }
    ]
}
Structure (object)
  • name
    string

    Optional

    The name of the participant.

    Max. length: 40 characters

    Example: "Jon Snow"

  • email
    string

    Optional

    The participant email.

    Max. length: 254 characters

    Example: "jonanddaenerys@westeros.got""

  • custom_user_identifier
    string|null

    Optional

    An external custom user identifier. Use the format that suits your needs.

    Max. length: 100 characters

    Example: "acme:account:1234"

  • checked_in
    boolean

    Optional

    Whether the participant is checked 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.

    Example: {}

  • lineup
    array[object]

    Optional

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

Response

[200] Participant update.

Example
{
    "name": "Jon Snow",
    "email": "jonanddaenerys@westeros.got\"",
    "custom_user_identifier": "acme:account:1234",
    "checked_in": true,
    "custom_fields": {},
    "id": "375143143408309123",
    "user_id": "145246939508809147",
    "checked_in_at": "2015-12-32T13:37:42+00:00",
    "lineup": [
        {
            "name": "Jon Snow",
            "custom_user_identifier": "acme:account:1234",
            "email": "jonanddaenerys@westeros.got\"",
            "custom_fields": {},
            "user_id": "145246939508809147"
        }
    ]
}
Structure (object)
  • name
    string

    The name of the participant.

    Max. length: 40 characters

    Example: "Jon Snow"

  • email
    string

    The participant email.

    Max. length: 254 characters

    Example: "jonanddaenerys@westeros.got""

  • custom_user_identifier
    string|null

    An external custom user identifier. Use the format that suits your needs.

    Max. length: 100 characters

    Example: "acme:account:1234"

  • checked_in
    boolean

    Whether the participant is checked 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.

    Example: {}

  • id
    string

    The id of the participant.

    Example: "375143143408309123"

  • user_id
    string|null

    The identifier of user associate to this participant.

    Example: "145246939508809147"

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

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

Authorized Access

Deletes a single participant of the given 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 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

[204] Success