Registrations

  • API v2.0
  • Participant API

Endpoints

GET /me/registrations

Authorized Access

Returns the registrations of the user associated to the access token.

Resource URL

https://api.toornament.com/participant/v2/me/registrations

HTTP headers

  • X-Api-Key
    string

    API key of your application (see Authentication)

  • Authorization
    string

    Access token with participant:manage_registrations scope (see Authorization)

  • Range
    string

    A range of requested items using the registrations unit. The size of the range cannot exceed 50. (see Pagination)

    Example: registrations=0-49

Query Parameters

  • tournament_ids
    string

    Only return registrations for the given list of tournaments.

    Example: 378426939508809728,534138941862841533

  • playlist_ids
    string

    Only return registrations for the tournaments listed in the playlist.

    Example: 123485236848698874,135864989139387313

Request Body

This endpoint doesn't require a request body.

Response

[206] Registrations retrieved

Example
[
    {
        "id": "375143143408309123",
        "tournament_id": "378426939508809728",
        "participant_id": "123426939548806789",
        "type": "team",
        "status": "accepted",
        "name": "A team or player name",
        "custom_fields": {
            "country": "GB",
            "twitter": "twitter_id"
        },
        "lineup": [
            {
                "name": "A team player name",
                "email": "player_1@team.com",
                "custom_fields": {
                    "country": "GB",
                    "twitter": "twitter_id"
                }
            }
        ]
    }
]
Structure (collection)
  • id
    string

    A unique identifier for this registration.

    Example: "375143143408309123"

  • tournament_id
    string

    The id of the tournament that contains this registration.

    Example: "378426939508809728"

  • participant_id
    string|null

    The id of the participant linked to this registration, it is null when registration is not accepted.

    Example: "123426939548806789"

  • type
    string

    The type of participants who plays in the tournament.

    Possible values: team, player

  • status
    string

    The status of the registration.

    Possible values: pending, accepted, refused, cancelled

  • name
    string

    A name (maximum 40 characters).

    Example: "A team or player name"

  • custom_fields
    object

    All 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]

    Optional

    A list of team players.

POST /me/registrations

Authorized Access

Creates a new registration for the user associated to the access token. The participant type of the tournament defines whether it expects a player or a team in the request body. If the registrations are disabled or closed, the endpoint will return a 403 (Access Denied).

Resource URL

https://api.toornament.com/participant/v2/me/registrations

HTTP headers

  • X-Api-Key
    string

    API key of your application (see Authentication)

  • Authorization
    string

    Access token with participant:manage_registrations scope (see Authorization)

Query Parameters

This endpoint doesn't have any query parameters.

Request Body

New registration

Example
{
    "tournament_id": "378426939508809728",
    "type": "team",
    "name": "A team or player name",
    "custom_fields": {
        "country": "GB",
        "twitter": "twitter_id"
    },
    "lineup": [
        {
            "name": "A team player name",
            "email": "player_1@team.com",
            "custom_fields": {
                "country": "GB",
                "twitter": "twitter_id"
            }
        }
    ]
}
Structure (object)
  • tournament_id
    string

    The id of the tournament that contains this registration.

    Example: "378426939508809728"

  • type
    string

    The type of participants who plays in the tournament.

    Possible values: team, player

  • name
    string

    A name (maximum 40 characters).

    Example: "A team or player name"

  • custom_fields
    object

    All 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]

    Optional

    A list of team players.

Response

[201] Registration created

Example
{
    "id": "375143143408309123",
    "tournament_id": "378426939508809728",
    "participant_id": "123426939548806789",
    "type": "team",
    "status": "accepted",
    "name": "A team or player name",
    "custom_fields": {
        "country": "GB",
        "twitter": "twitter_id"
    },
    "lineup": [
        {
            "name": "A team player name",
            "email": "player_1@team.com",
            "custom_fields": {
                "country": "GB",
                "twitter": "twitter_id"
            }
        }
    ]
}
Structure (object)
  • id
    string

    A unique identifier for this registration.

    Example: "375143143408309123"

  • tournament_id
    string

    The id of the tournament that contains this registration.

    Example: "378426939508809728"

  • participant_id
    string|null

    The id of the participant linked to this registration, it is null when registration is not accepted.

    Example: "123426939548806789"

  • type
    string

    The type of participants who plays in the tournament.

    Possible values: team, player

  • status
    string

    The status of the registration.

    Possible values: pending, accepted, refused, cancelled

  • name
    string

    A name (maximum 40 characters).

    Example: "A team or player name"

  • custom_fields
    object

    All 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]

    Optional

    A list of team players.

GET /me/registrations/{id}

Authorized Access

Returns a registration by the given id and user associated to the access token. If the registration does not exist or is not associated to the user, the endpoint will return a 404 (Not Found).

Resource URL

https://api.toornament.com/participant/v2/me/registrations/{id}

HTTP headers

  • X-Api-Key
    string

    API key of your application (see Authentication)

  • Authorization
    string

    Access token with participant:manage_registrations scope (see Authorization)

Path parameters

  • id
    string

    The unique identifier of the registration to retrieve

Query Parameters

This endpoint doesn't have any query parameters.

Request Body

This endpoint doesn't require a request body.

Response

[200] Registration retrieved

Example
{
    "id": "375143143408309123",
    "tournament_id": "378426939508809728",
    "participant_id": "123426939548806789",
    "type": "team",
    "status": "accepted",
    "name": "A team or player name",
    "custom_fields": {
        "country": "GB",
        "twitter": "twitter_id"
    },
    "lineup": [
        {
            "name": "A team player name",
            "email": "player_1@team.com",
            "custom_fields": {
                "country": "GB",
                "twitter": "twitter_id"
            }
        }
    ]
}
Structure (object)
  • id
    string

    A unique identifier for this registration.

    Example: "375143143408309123"

  • tournament_id
    string

    The id of the tournament that contains this registration.

    Example: "378426939508809728"

  • participant_id
    string|null

    The id of the participant linked to this registration, it is null when registration is not accepted.

    Example: "123426939548806789"

  • type
    string

    The type of participants who plays in the tournament.

    Possible values: team, player

  • status
    string

    The status of the registration.

    Possible values: pending, accepted, refused, cancelled

  • name
    string

    A name (maximum 40 characters).

    Example: "A team or player name"

  • custom_fields
    object

    All 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]

    Optional

    A list of team players.

PATCH /me/registrations/{id}

Authorized Access

Updates a registration by the given id and user associated to the access token. Also you can change the status into "cancelled" when is "pending" or "accepted" (and not in a stage). Whenever the registration is accepted, after update of information, registration's status will automatically change into "pending".

Resource URL

https://api.toornament.com/participant/v2/me/registrations/{id}

HTTP headers

  • X-Api-Key
    string

    API key of your application (see Authentication)

  • Authorization
    string

    Access token with participant:manage_registrations scope (see Authorization)

Path parameters

  • id
    string

    The unique identifier of the registration to retrieve

Query Parameters

This endpoint doesn't have any query parameters.

Request Body

Update registration

Example
{
    "name": "A team or player name",
    "status": "cancelled",
    "custom_fields": {
        "country": "GB",
        "twitter": "twitter_id"
    },
    "lineup": [
        {
            "name": "A team player name",
            "email": "player_1@team.com",
            "custom_fields": {
                "country": "GB",
                "twitter": "twitter_id"
            }
        }
    ]
}
Structure (object)
  • name
    string

    Optional

    A name (maximum 40 characters).

    Example: "A team or player name"

  • status
    string

    Optional

    The status of the registration.

    Possible values: pending, accepted, refused, cancelled

  • custom_fields
    object

    Optional

    All 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]

    Optional

    A list of team players.

Response

[200] Registration retrieved

Example
{
    "id": "375143143408309123",
    "tournament_id": "378426939508809728",
    "participant_id": "123426939548806789",
    "type": "team",
    "status": "accepted",
    "name": "A team or player name",
    "custom_fields": {
        "country": "GB",
        "twitter": "twitter_id"
    },
    "lineup": [
        {
            "name": "A team player name",
            "email": "player_1@team.com",
            "custom_fields": {
                "country": "GB",
                "twitter": "twitter_id"
            }
        }
    ]
}
Structure (object)
  • id
    string

    A unique identifier for this registration.

    Example: "375143143408309123"

  • tournament_id
    string

    The id of the tournament that contains this registration.

    Example: "378426939508809728"

  • participant_id
    string|null

    The id of the participant linked to this registration, it is null when registration is not accepted.

    Example: "123426939548806789"

  • type
    string

    The type of participants who plays in the tournament.

    Possible values: team, player

  • status
    string

    The status of the registration.

    Possible values: pending, accepted, refused, cancelled

  • name
    string

    A name (maximum 40 characters).

    Example: "A team or player name"

  • custom_fields
    object

    All 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]

    Optional

    A list of team players.