Participants (BoA)

Brawl of Ages

This documentation provides information specifically for the Brawl of Ages discipline.

Endpoints

GET /tournaments/{tournament_id}/participants

Returns a collection of participants from one tournament. The tournament must be public to have access to its participants, meaning the tournament organizer has published it. The participants are returned by 256.

Resource URL

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

Path parameters

  • tournament_id
    string

    Identifier of the tournament participants.

Query Parameters

  • with_lineup
    boolean

    When set to '1', it will include the lineup of the team (works only if the participant is a team).

    Allowed values: 1, 0

    Default: 0

  • with_custom_fields
    boolean

    When set to '1', it will include the list of custom fields for this participant.

    Allowed values: 1, 0

    Default: 0

  • sort
    string

    Sorts the collection in a particular order. "date_asc" sorts the participants from older to newer; "alphabetic" sorts the participants alphabetically (case sensitive).

    Allowed values: date_asc, alphabetic

    Default: date_asc

  • page
    integer

    Page requested of the list.

    Default: 1

Request Body

This endpoint doesn't require a request body.

Response

[200] Success

Example
[
    {
        "id": "378426939508809728",
        "name": "Evil Geniuses",
        "logo": {
            "icon_large_square": "http:\/\/api.toornament.com\/id\/icon_large_square",
            "extra_small_square": "http:\/\/api.toornament.com\/id\/extra_small_square",
            "medium_small_square": "http:\/\/api.toornament.com\/id\/medium_small_square",
            "medium_large_square": "http:\/\/api.toornament.com\/id\/medium_large_square"
        },
        "country": "US",
        "lineup": [
            {
                "name": "Storm Spirit",
                "country": "US",
                "custom_fields": [
                    {
                        "type": "steam_player_id",
                        "label": "Steam ID",
                        "value": "STEAM_0:1:1234567"
                    }
                ],
                "email": "player@oxent.net",
                "custom_fields_private": [
                    {
                        "type": "steam_player_id",
                        "label": "Steam ID",
                        "value": "STEAM_0:1:1234567"
                    }
                ]
            }
        ],
        "custom_fields": [
            {
                "type": "steam_player_id",
                "label": "Steam ID",
                "value": "STEAM_0:1:1234567"
            }
        ],
        "email": "contact@oxent.net",
        "check_in": true,
        "custom_fields_private": [
            {
                "type": "steam_player_id",
                "label": "Steam ID",
                "value": "STEAM_0:1:1234567"
            }
        ]
    }
]
Structure (collection)
  • id
    string

    Unique identifier for this participant.

    Example: "378426939508809728"

  • name
    string

    Participant name (maximum 40 characters).

    Example: "Evil Geniuses"

  • logo
    object|null

    Logo of the participant.

  • country
    string|null

    Optional

    Country of the participant. This property is only available when the "country" option is enabled for this tournament. This value is represented as an ISO 3166-1 alpha-2 country code.

    Example: "US"

  • lineup
    array[object]

    Optional

    This property is only available when the participant type is "team".

  • custom_fields
    array[object]

    Optional

    List of public custom fields

  • email
    string

    PrivateOptional

    Participant email.

    Example: "contact@oxent.net"

  • check_in
    boolean

    PrivateOptional

    Participant check-in. This property is only available when "check-in" option is enabled for this tournament.

    Example: true

  • custom_fields_private
    array[object]

    PrivateOptional

    This property is only available when the query parameter 'with_custom_fields' is true.

POST /tournaments/{tournament_id}/participants

Authorized Access

Create a participant in a tournament.

Warning! This endpoint can only be used with an Authorized Access.

Resource URL

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

Query Parameters

This endpoint doesn't have any query parameters.

Request Body

Create a participant

Example
{
    "name": "Evil Geniuses",
    "email": "contact@oxent.net",
    "country": "US",
    "lineup": [
        {
            "name": "Storm Spirit",
            "email": "contact@oxent.net",
            "country": "US"
        }
    ]
}
Structure (object)
  • name
    string

    Participant name (maximum 40 characters).

    Example: "Evil Geniuses"

  • email
    string|null

    Optional

    Participant email.

    Example: "contact@oxent.net"

  • country
    string|null

    Optional

    Country of the participant. This property is only available when the "country" option is enabled for this tournament. This value is represented as an ISO 3166-1 alpha-2 country code.

    Example: "US"

  • lineup
    array[object]

    Optional

    This property is only available when the participant type is "team".

Response

[201] Success

Example
{
    "id": "378426939508809728",
    "name": "Evil Geniuses",
    "logo": null,
    "email": "contact@oxent.net",
    "check_in": false,
    "country": "US",
    "lineup": [
        {
            "name": "Storm Spirit",
            "email": "contact@oxent.net",
            "country": "US"
        }
    ]
}
Structure (object)
  • id
    string

    Unique identifier for this participant.

    Example: "378426939508809728"

  • name
    string

    Participant name (maximum 40 characters).

    Example: "Evil Geniuses"

  • logo
    object|null

    Logo of the participant.

  • email
    string|null

    Participant email.

    Example: "contact@oxent.net"

  • check_in
    boolean

    Optional

    Participant check-in. This property is only available when "check-in" option is enabled for this tournament.

    Example: false

  • country
    string|null

    Optional

    Country of the participant. This property is only available when the "country" option is enabled for this tournament. This value is represented as an ISO 3166-1 alpha-2 country code.

    Example: "US"

  • lineup
    array[object]

    Optional

    This property is only available when the participant type is "team".

PUT /tournaments/{tournament_id}/participants

Authorized Access

Create a list of participants in a tournament. If any participant already exists he will be erased.

Warning! This endpoint can only be used with an Authorized Access.

Resource URL

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

Query Parameters

This endpoint doesn't have any query parameters.

Request Body

Create a participant

Example
[
    {
        "name": "Evil Geniuses",
        "email": "contact@oxent.net",
        "country": "US",
        "lineup": [
            {
                "name": "Storm Spirit",
                "email": "contact@oxent.net",
                "country": "US"
            }
        ]
    }
]
Structure (collection)
  • name
    string

    Participant name (maximum 40 characters).

    Example: "Evil Geniuses"

  • email
    string|null

    Participant email.

    Example: "contact@oxent.net"

  • country
    string|null

    Country of the participant. This property is only available when the "country" option is enabled for this tournament. This value is represented as an ISO 3166-1 alpha-2 country code.

    Example: "US"

  • lineup
    array[object]

    This property is only available when the participant type is "team".

Response

[201] Success

Example
[
    {
        "name": "Evil Geniuses",
        "email": "contact@oxent.net",
        "country": "US",
        "lineup": [
            {
                "name": "Storm Spirit",
                "email": "contact@oxent.net",
                "country": "US"
            }
        ]
    }
]
Structure (collection)
  • name
    string

    Participant name (maximum 40 characters).

    Example: "Evil Geniuses"

  • email
    string|null

    Participant email.

    Example: "contact@oxent.net"

  • country
    string|null

    Country of the participant. This property is only available when the "country" option is enabled for this tournament. This value is represented as an ISO 3166-1 alpha-2 country code.

    Example: "US"

  • lineup
    array[object]

    This property is only available when the participant type is "team".

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

Returns detailed information about one participant.

Resource URL

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

Path parameters

  • tournament_id
    string

    The identifier of the tournament participants.

  • id
    string

    A unique identifier 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] Success

Example
{
    "id": "378426939508809728",
    "name": "Evil Geniuses",
    "logo": {
        "icon_large_square": "http:\/\/api.toornament.com\/id\/icon_large_square",
        "extra_small_square": "http:\/\/api.toornament.com\/id\/extra_small_square",
        "medium_small_square": "http:\/\/api.toornament.com\/id\/medium_small_square",
        "medium_large_square": "http:\/\/api.toornament.com\/id\/medium_large_square"
    },
    "country": "US",
    "lineup": [
        {
            "name": "Storm Spirit",
            "country": "US",
            "custom_fields": [
                {
                    "type": "steam_player_id",
                    "label": "Steam ID",
                    "value": "STEAM_0:1:1234567"
                }
            ],
            "email": "player@oxent.net",
            "custom_fields_private": [
                {
                    "type": "steam_player_id",
                    "label": "Steam ID",
                    "value": "STEAM_0:1:1234567"
                }
            ]
        }
    ],
    "custom_fields": [
        {
            "type": "steam_player_id",
            "label": "Steam ID",
            "value": "STEAM_0:1:1234567"
        }
    ],
    "email": "contact@oxent.net",
    "check_in": true,
    "custom_fields_private": [
        {
            "type": "steam_player_id",
            "label": "Steam ID",
            "value": "STEAM_0:1:1234567"
        }
    ]
}
Structure (object)
  • id
    string

    Unique identifier for this participant.

    Example: "378426939508809728"

  • name
    string

    Participant name (maximum 40 characters).

    Example: "Evil Geniuses"

  • logo
    object|null

    Logo of the participant.

  • country
    string|null

    Optional

    Country of the participant. This property is only available when the "country" option is enabled for this tournament. This value is represented as an ISO 3166-1 alpha-2 country code.

    Example: "US"

  • lineup
    array[object]

    Optional

    This property is only available when the participant type is "team".

  • custom_fields
    array[object]

    Optional

    List of public custom fields

  • email
    string

    PrivateOptional

    Participant email.

    Example: "contact@oxent.net"

  • check_in
    boolean

    PrivateOptional

    Participant check-in. This property is only available when "check-in" option is enabled for this tournament.

    Example: true

  • custom_fields_private
    array[object]

    PrivateOptional

    List of private custom fields

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

Authorized Access

Update some of the editable information on a participant.

Warning! This endpoint can only be used with an Authorized Access.

Resource URL

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

Path parameters

  • tournament_id
    string

    The identifier of the tournament participants.

  • id
    string

    A unique identifier of the participant to retrieve.

Query Parameters

This endpoint doesn't have any query parameters.

Request Body

Participant data to patch

Example
{
    "name": "Evil Geniuses",
    "email": "contact@oxent.net",
    "country": "US",
    "lineup": [
        {
            "name": "Storm Spirit",
            "email": "contact@oxent.net",
            "country": "US"
        }
    ]
}
Structure (object)
  • name
    string

    Participant name (maximum 40 characters).

    Example: "Evil Geniuses"

  • email
    string|null

    Participant email.

    Example: "contact@oxent.net"

  • country
    string|null

    Country of the participant. This property is only available when the "country" option is enabled for this tournament. This value is represented as an ISO 3166-1 alpha-2 country code.

    Example: "US"

  • lineup
    array[object]

    This property is only available when the participant type is "team".

Response

[200] Success

Example
{
    "id": "378426939508809728",
    "name": "Evil Geniuses",
    "email": "contact@oxent.net",
    "logo": {
        "icon_large_square": "http:\/\/api.toornament.com\/id\/icon_large_square",
        "extra_small_square": "http:\/\/api.toornament.com\/id\/extra_small_square",
        "medium_small_square": "http:\/\/api.toornament.com\/id\/medium_small_square",
        "medium_large_square": "http:\/\/api.toornament.com\/id\/medium_large_square"
    },
    "check_in": false,
    "country": "US",
    "lineup": [
        {
            "name": "Storm Spirit",
            "country": "US",
            "custom_fields": [
                {
                    "type": "steam_player_id",
                    "label": "Steam ID",
                    "value": "STEAM_0:1:1234567"
                }
            ],
            "email": "player@oxent.net",
            "custom_fields_private": [
                {
                    "type": "steam_player_id",
                    "label": "Steam ID",
                    "value": "STEAM_0:1:1234567"
                }
            ]
        }
    ],
    "custom_fields": [
        {
            "type": "steam_player_id",
            "label": "Steam ID",
            "value": "STEAM_0:1:1234567"
        }
    ],
    "custom_fields_private": [
        {
            "type": "steam_player_id",
            "label": "Steam ID",
            "value": "STEAM_0:1:1234567"
        }
    ]
}
Structure (object)
  • id
    string

    Unique identifier for this participant.

    Example: "378426939508809728"

  • name
    string

    Participant name (maximum 40 characters).

    Example: "Evil Geniuses"

  • email
    string|null

    Participant email.

    Example: "contact@oxent.net"

  • logo
    object|null

    Logo of the participant.

  • check_in
    boolean

    Optional

    Participant check-in. This property is only available when "check-in" option is enabled for this tournament.

    Example: false

  • country
    string|null

    Optional

    Country of the participant. This property is only available when the "country" option is enabled for this tournament. This value is represented as an ISO 3166-1 alpha-2 country code.

    Example: "US"

  • lineup
    array[object]

    Optional

    This property is only available when the participant type is "team".

  • custom_fields
    array[object]

    Optional

    List of public custom fields

  • custom_fields_private
    array[object]

    Optional

    List of private custom fields

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

Authorized Access

Deletes one participant.

Warning! This endpoint can only be used with an Authorized Access.

Resource URL

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

Path parameters

  • tournament_id
    string

    The identifier of the tournament participants.

  • id
    string

    A unique identifier 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

[204] Success