Tournament API › Participants

GET /participants

Retrieves the participants of all your tournaments.

Resource URL

https://api.toornament.com/organizer/v2/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

Query Parameters

  • name
    string

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

  • tournament_ids
    array

    Only return participants for the given list of tournaments.

    Example: 378426939508809728,534138941862841533

  • is_checked_in
    boolean

    Whether the participant is checked in.

    Possible values: 0, 1

  • custom_user_identifiers
    array

    A list of external custom user identifiers.

    Example: acme:account:1234,acme:account:1235

  • participant_ids
    array

    Only return participants for the given list of participant.

    Example: 378426939508809728,534138941862841533

  • 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
[
    {
        "type": "team",
        "tournament_id": "378426939508809728",
        "id": "375143143408309123",
        "email": "[email protected]",
        "name": "Jon Snow",
        "user_id": "145246939508809147",
        "custom_user_identifier": "acme:account:1234",
        "checked_in": true,
        "custom_fields": {},
        "lineup": [
            {
                "name": "Jon Snow",
                "custom_user_identifier": "acme:account:1234",
                "user_id": "145246939508809147",
                "email": "[email protected]",
                "custom_fields": {}
            }
        ],
        "created_at": "2015-12-09T13:37:42+00:00"
    }
]
Structure (collection)
  • type
    string

    The type of participants who plays in the tournament.

    Possible values: team, player

  • tournament_id
    string

    The id of the tournament that contains this participant.

    Example: "378426939508809728"

  • id
    string

    The id of the participant.

    Example: "375143143408309123"

  • email
    string|null

    The participant email.

    Max. length: 180 characters

    Example: "[email protected]"

  • name
    string

    The name of the participant.

    Max. length: 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 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: {}

  • lineup
    array[object]

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

  • created_at
    string

    The date and time of the participant creation, in RFC 3339 format (combined date, time and utc offset).

    Format: datetime

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

POST /participants

Creates a new participant.

Resource URL

https://api.toornament.com/organizer/v2/participants

HTTP headers

  • X-Api-Key
    string

    API key of your application (see Authentication)

  • Authorization
    string

    Access token with organizer:participant scope (see Authorization)

Query Parameters

  • custom_field_required
    integer

    Allow required custom fields empty

    Possible values: 0, 1

    Default: 0

Request Body

Participant data.

Example
{
    "type": "player",
    "tournament_id": "378426939508809728",
    "name": "Jon Snow",
    "email": "[email protected]",
    "custom_user_identifier": "acme:account:1234",
    "checked_in": true,
    "custom_fields": {},
    "lineup": [
        {
            "name": "Jon Snow",
            "custom_user_identifier": "acme:account:1234",
            "email": "[email protected]",
            "custom_fields": {}
        }
    ]
}
Structure (object)
  • type
    string

    The type of participants who plays in the tournament.

    Possible values: team, player

  • tournament_id
    string

    The id of the tournament that contains this participant.

    Example: "378426939508809728"

  • name
    string

    The name of the participant.

    Max. length: 40 characters

    Example: "Jon Snow"

  • email
    string|null

    Optional

    The participant email.

    Max. length: 180 characters

    Example: "[email protected]"

  • 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
{
    "type": "team",
    "tournament_id": "378426939508809728",
    "checked_in_at": "2015-12-32T13:37:42+00:00",
    "id": "375143143408309123",
    "email": "[email protected]",
    "name": "Jon Snow",
    "user_id": "145246939508809147",
    "custom_user_identifier": "acme:account:1234",
    "checked_in": true,
    "custom_fields": {},
    "lineup": [
        {
            "name": "Jon Snow",
            "custom_user_identifier": "acme:account:1234",
            "user_id": "145246939508809147",
            "email": "[email protected]",
            "custom_fields": {}
        }
    ],
    "created_at": "2015-12-09T13:37:42+00:00"
}
Structure (object)
  • type
    string

    The type of participants who plays in the tournament.

    Possible values: team, player

  • tournament_id
    string

    The id of the tournament that contains this participant.

    Example: "378426939508809728"

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

  • id
    string

    The id of the participant.

    Example: "375143143408309123"

  • email
    string|null

    The participant email.

    Max. length: 180 characters

    Example: "[email protected]"

  • name
    string

    The name of the participant.

    Max. length: 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 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: {}

  • lineup
    array[object]

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

  • created_at
    string

    The date and time of the participant creation, in RFC 3339 format (combined date, time and utc offset).

    Format: datetime

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

GET /participants/{id}

Retrieves 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/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

  • 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
{
    "type": "team",
    "tournament_id": "378426939508809728",
    "checked_in_at": "2015-12-32T13:37:42+00:00",
    "id": "375143143408309123",
    "email": "[email protected]",
    "name": "Jon Snow",
    "user_id": "145246939508809147",
    "custom_user_identifier": "acme:account:1234",
    "checked_in": true,
    "custom_fields": {},
    "lineup": [
        {
            "name": "Jon Snow",
            "custom_user_identifier": "acme:account:1234",
            "user_id": "145246939508809147",
            "email": "[email protected]",
            "custom_fields": {}
        }
    ],
    "created_at": "2015-12-09T13:37:42+00:00"
}
Structure (object)
  • type
    string

    The type of participants who plays in the tournament.

    Possible values: team, player

  • tournament_id
    string

    The id of the tournament that contains this participant.

    Example: "378426939508809728"

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

  • id
    string

    The id of the participant.

    Example: "375143143408309123"

  • email
    string|null

    The participant email.

    Max. length: 180 characters

    Example: "[email protected]"

  • name
    string

    The name of the participant.

    Max. length: 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 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: {}

  • lineup
    array[object]

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

  • created_at
    string

    The date and time of the participant creation, in RFC 3339 format (combined date, time and utc offset).

    Format: datetime

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

PATCH /participants/{id}

Updates a participant identified by the given id. 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/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

  • id
    string

    The id of the participant to retrieve.

Query Parameters

  • custom_field_required
    integer

    Allow required custom fields empty

    Possible values: 0, 1

    Default: 0

Request Body

Participant data.

Example
{
    "name": "Jon Snow",
    "email": "[email protected]",
    "custom_user_identifier": "acme:account:1234",
    "checked_in": true,
    "custom_fields": {},
    "lineup": [
        {
            "name": "Jon Snow",
            "custom_user_identifier": "acme:account:1234",
            "email": "[email protected]",
            "custom_fields": {}
        }
    ]
}
Structure (object)
  • name
    string

    Optional

    The name of the participant.

    Max. length: 40 characters

    Example: "Jon Snow"

  • email
    string|null

    Optional

    The participant email.

    Max. length: 180 characters

    Example: "[email protected]"

  • 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
{
    "type": "team",
    "tournament_id": "378426939508809728",
    "checked_in_at": "2015-12-32T13:37:42+00:00",
    "id": "375143143408309123",
    "email": "[email protected]",
    "name": "Jon Snow",
    "user_id": "145246939508809147",
    "custom_user_identifier": "acme:account:1234",
    "checked_in": true,
    "custom_fields": {},
    "lineup": [
        {
            "name": "Jon Snow",
            "custom_user_identifier": "acme:account:1234",
            "user_id": "145246939508809147",
            "email": "[email protected]",
            "custom_fields": {}
        }
    ],
    "created_at": "2015-12-09T13:37:42+00:00"
}
Structure (object)
  • type
    string

    The type of participants who plays in the tournament.

    Possible values: team, player

  • tournament_id
    string

    The id of the tournament that contains this participant.

    Example: "378426939508809728"

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

  • id
    string

    The id of the participant.

    Example: "375143143408309123"

  • email
    string|null

    The participant email.

    Max. length: 180 characters

    Example: "[email protected]"

  • name
    string

    The name of the participant.

    Max. length: 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 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: {}

  • lineup
    array[object]

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

  • created_at
    string

    The date and time of the participant creation, in RFC 3339 format (combined date, time and utc offset).

    Format: datetime

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

DELETE /participants/{id}

Deletes a participant identified by the given id.

Resource URL

https://api.toornament.com/organizer/v2/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

  • 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

LegacyGET /tournaments/{tournament_id}/participants

This endpoint is in legacy mode. Access will soon be deprecated. It is therefore advised to use another endpoint when possible.

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
[
    {
        "id": "375143143408309123",
        "email": "[email protected]",
        "name": "Jon Snow",
        "user_id": "145246939508809147",
        "custom_user_identifier": "acme:account:1234",
        "checked_in": true,
        "custom_fields": {},
        "lineup": [
            {
                "name": "Jon Snow",
                "custom_user_identifier": "acme:account:1234",
                "user_id": "145246939508809147",
                "email": "[email protected]",
                "custom_fields": {}
            }
        ],
        "created_at": "2015-12-09T13:37:42+00:00"
    }
]
Structure (collection)
  • id
    string

    The id of the participant.

    Example: "375143143408309123"

  • email
    string|null

    The participant email.

    Max. length: 180 characters

    Example: "[email protected]"

  • name
    string

    The name of the participant.

    Max. length: 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 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: {}

  • lineup
    array[object]

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

  • created_at
    string

    The date and time of the participant creation, in RFC 3339 format (combined date, time and utc offset).

    Format: datetime

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

LegacyPOST /tournaments/{tournament_id}/participants

This endpoint is in legacy mode. Access will soon be deprecated. It is therefore advised to use another endpoint when possible.

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": "[email protected]",
    "custom_user_identifier": "acme:account:1234",
    "checked_in": true,
    "custom_fields": {},
    "lineup": [
        {
            "name": "Jon Snow",
            "custom_user_identifier": "acme:account:1234",
            "email": "[email protected]",
            "custom_fields": {}
        }
    ]
}
Structure (object)
  • name
    string

    The name of the participant.

    Max. length: 40 characters

    Example: "Jon Snow"

  • email
    string|null

    Optional

    The participant email.

    Max. length: 180 characters

    Example: "[email protected]"

  • 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
{
    "checked_in_at": "2015-12-32T13:37:42+00:00",
    "id": "375143143408309123",
    "email": "[email protected]",
    "name": "Jon Snow",
    "user_id": "145246939508809147",
    "custom_user_identifier": "acme:account:1234",
    "checked_in": true,
    "custom_fields": {},
    "lineup": [
        {
            "name": "Jon Snow",
            "custom_user_identifier": "acme:account:1234",
            "user_id": "145246939508809147",
            "email": "[email protected]",
            "custom_fields": {}
        }
    ],
    "created_at": "2015-12-09T13:37:42+00:00"
}
Structure (object)
  • 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"

  • id
    string

    The id of the participant.

    Example: "375143143408309123"

  • email
    string|null

    The participant email.

    Max. length: 180 characters

    Example: "[email protected]"

  • name
    string

    The name of the participant.

    Max. length: 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 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: {}

  • lineup
    array[object]

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

  • created_at
    string

    The date and time of the participant creation, in RFC 3339 format (combined date, time and utc offset).

    Format: datetime

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

LegacyGET /tournaments/{tournament_id}/participants/{id}

This endpoint is in legacy mode. Access will soon be deprecated. It is therefore advised to use another endpoint when possible.

Returns a 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
{
    "checked_in_at": "2015-12-32T13:37:42+00:00",
    "id": "375143143408309123",
    "email": "[email protected]",
    "name": "Jon Snow",
    "user_id": "145246939508809147",
    "custom_user_identifier": "acme:account:1234",
    "checked_in": true,
    "custom_fields": {},
    "lineup": [
        {
            "name": "Jon Snow",
            "custom_user_identifier": "acme:account:1234",
            "user_id": "145246939508809147",
            "email": "[email protected]",
            "custom_fields": {}
        }
    ],
    "created_at": "2015-12-09T13:37:42+00:00"
}
Structure (object)
  • 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"

  • id
    string

    The id of the participant.

    Example: "375143143408309123"

  • email
    string|null

    The participant email.

    Max. length: 180 characters

    Example: "[email protected]"

  • name
    string

    The name of the participant.

    Max. length: 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 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: {}

  • lineup
    array[object]

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

  • created_at
    string

    The date and time of the participant creation, in RFC 3339 format (combined date, time and utc offset).

    Format: datetime

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

LegacyPATCH /tournaments/{tournament_id}/participants/{id}

This endpoint is in legacy mode. Access will soon be deprecated. It is therefore advised to use another endpoint when possible.

Updates a 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": "[email protected]",
    "custom_user_identifier": "acme:account:1234",
    "checked_in": true,
    "custom_fields": {},
    "lineup": [
        {
            "name": "Jon Snow",
            "custom_user_identifier": "acme:account:1234",
            "email": "[email protected]",
            "custom_fields": {}
        }
    ]
}
Structure (object)
  • name
    string

    Optional

    The name of the participant.

    Max. length: 40 characters

    Example: "Jon Snow"

  • email
    string|null

    Optional

    The participant email.

    Max. length: 180 characters

    Example: "[email protected]"

  • 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
{
    "checked_in_at": "2015-12-32T13:37:42+00:00",
    "id": "375143143408309123",
    "email": "[email protected]",
    "name": "Jon Snow",
    "user_id": "145246939508809147",
    "custom_user_identifier": "acme:account:1234",
    "checked_in": true,
    "custom_fields": {},
    "lineup": [
        {
            "name": "Jon Snow",
            "custom_user_identifier": "acme:account:1234",
            "user_id": "145246939508809147",
            "email": "[email protected]",
            "custom_fields": {}
        }
    ],
    "created_at": "2015-12-09T13:37:42+00:00"
}
Structure (object)
  • 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"

  • id
    string

    The id of the participant.

    Example: "375143143408309123"

  • email
    string|null

    The participant email.

    Max. length: 180 characters

    Example: "[email protected]"

  • name
    string

    The name of the participant.

    Max. length: 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 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: {}

  • lineup
    array[object]

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

  • created_at
    string

    The date and time of the participant creation, in RFC 3339 format (combined date, time and utc offset).

    Format: datetime

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

LegacyDELETE /tournaments/{tournament_id}/participants/{id}

This endpoint is in legacy mode. Access will soon be deprecated. It is therefore advised to use another endpoint when possible.

Deletes a 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