Registrations

GET /tournaments/{tournament_id}/registrations

Authorized Access

Returns the registrations of the given tournament.

Resource URL

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

HTTP headers

  • X-Api-Key
    string

    API key of your application (see Authentication)

  • Authorization
    string

    Access token with organizer:registration scope (see Authorization)

  • Range
    string

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

    Example: registrations=0-49

Path parameters

  • tournament_id
    string

    The id of the tournament containing the registration.

Query Parameters

  • sort
    string

    Sorts the registrations depending on their creation date. "scheduled_asc" sorts the registrations from the oldest to the most recent one; "scheduled_desc" sorts them from the most recent to the oldest one.

    Possible values: created_asc, created_desc

    Default: created_asc

Request Body

This endpoint does not require a request body.

Response

[206] Registrations retrieved

Example
[
    {
        "name": "A team player name",
        "email": "player_1@team.com",
        "custom_user_identifier": "acme:account:1234",
        "custom_fields": {},
        "id": "375143143408309123",
        "type": "team",
        "tournament_id": "378426939508809728",
        "participant_id": "375143143408309123",
        "user_id": "145246939508809147",
        "status": "pending",
        "lineup": [
            {
                "name": "A team player name",
                "email": "player_1@team.com",
                "custom_user_identifier": "acme:account:1234",
                "custom_fields": {},
                "user_id": "145246939508809147"
            }
        ]
    }
]
Structure (collection)
  • name
    string

    The name of the registration.

    Max. length: 40 characters

    Example: "A team player name"

  • email
    string|null

    The email of the team player.

    Max. length: 254 characters

    Example: "player_1@team.com"

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

  • 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 unique identifier of this registration.

    Example: "375143143408309123"

  • type
    string

    The type of participants that play in the tournament.

    Possible values: team, player

  • tournament_id
    string

    The id of the tournament.

    Example: "378426939508809728"

  • participant_id
    string|null

    The id of the participant.

    Example: "375143143408309123"

  • user_id
    string|null

    The identifier of the user associated to this registration.

    Example: "145246939508809147"

  • status
    string

    The status of the registration.

    Possible values: pending, accepted, refused, cancelled

  • lineup
    array[object]

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

POST /tournaments/{tournament_id}/registrations

Authorized Access

Creates a new registration. 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/organizer/v2/tournaments/{tournament_id}/registrations

HTTP headers

  • X-Api-Key
    string

    API key of your application (see Authentication)

  • Authorization
    string

    Access token with organizer:registration scope (see Authorization)

Path parameters

  • tournament_id
    string

    The id of the tournament containing the registration.

Query Parameters

This endpoint does not have any query parameters.

Request Body

Data to provide for create the registration.

Example
{
    "name": "A team player name",
    "email": "player_1@team.com",
    "custom_user_identifier": "acme:account:1234",
    "custom_fields": {},
    "type": "team",
    "lineup": [
        {
            "name": "A team player name",
            "email": "player_1@team.com",
            "custom_user_identifier": "acme:account:1234",
            "custom_fields": {}
        }
    ]
}
Structure (object)
  • name
    string

    The name of the registration.

    Max. length: 40 characters

    Example: "A team player name"

  • email
    string|null

    Optional

    The email of the team player.

    Max. length: 254 characters

    Example: "player_1@team.com"

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

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

  • type
    string

    The type of participants that play in the tournament.

    Possible values: team, player

  • lineup
    array[object]

    Optional

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

Response

[201] Registration created

Example
{
    "name": "A team player name",
    "email": "player_1@team.com",
    "custom_user_identifier": "acme:account:1234",
    "custom_fields": {},
    "id": "375143143408309123",
    "type": "team",
    "tournament_id": "378426939508809728",
    "participant_id": "375143143408309123",
    "user_id": "145246939508809147",
    "status": "pending",
    "lineup": [
        {
            "name": "A team player name",
            "email": "player_1@team.com",
            "custom_user_identifier": "acme:account:1234",
            "custom_fields": {},
            "user_id": "145246939508809147"
        }
    ]
}
Structure (object)
  • name
    string

    The name of the registration.

    Max. length: 40 characters

    Example: "A team player name"

  • email
    string|null

    The email of the team player.

    Max. length: 254 characters

    Example: "player_1@team.com"

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

  • 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 unique identifier of this registration.

    Example: "375143143408309123"

  • type
    string

    The type of participants that play in the tournament.

    Possible values: team, player

  • tournament_id
    string

    The id of the tournament.

    Example: "378426939508809728"

  • participant_id
    string|null

    The id of the participant.

    Example: "375143143408309123"

  • user_id
    string|null

    The identifier of the user associated to this registration.

    Example: "145246939508809147"

  • status
    string

    The status of the registration.

    Possible values: pending, accepted, refused, cancelled

  • lineup
    array[object]

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

GET /tournaments/{tournament_id}/registrations/{id}

Authorized Access

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

Resource URL

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

HTTP headers

  • X-Api-Key
    string

    API key of your application (see Authentication)

  • Authorization
    string

    Access token with organizer:registration scope (see Authorization)

Path parameters

  • tournament_id
    string

    The id of the tournament containing the registration.

  • id
    string

    The unique identifier of the registration to retrieve.

Query Parameters

This endpoint does not have any query parameters.

Request Body

This endpoint does not require a request body.

Response

[200] Registration retrieved.

Example
{
    "name": "A team player name",
    "email": "player_1@team.com",
    "custom_user_identifier": "acme:account:1234",
    "custom_fields": {},
    "id": "375143143408309123",
    "type": "team",
    "tournament_id": "378426939508809728",
    "participant_id": "375143143408309123",
    "user_id": "145246939508809147",
    "status": "pending",
    "lineup": [
        {
            "name": "A team player name",
            "email": "player_1@team.com",
            "custom_user_identifier": "acme:account:1234",
            "custom_fields": {},
            "user_id": "145246939508809147"
        }
    ]
}
Structure (object)
  • name
    string

    The name of the registration.

    Max. length: 40 characters

    Example: "A team player name"

  • email
    string|null

    The email of the team player.

    Max. length: 254 characters

    Example: "player_1@team.com"

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

  • 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 unique identifier of this registration.

    Example: "375143143408309123"

  • type
    string

    The type of participants that play in the tournament.

    Possible values: team, player

  • tournament_id
    string

    The id of the tournament.

    Example: "378426939508809728"

  • participant_id
    string|null

    The id of the participant.

    Example: "375143143408309123"

  • user_id
    string|null

    The identifier of the user associated to this registration.

    Example: "145246939508809147"

  • status
    string

    The status of the registration.

    Possible values: pending, accepted, refused, cancelled

  • lineup
    array[object]

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

PATCH /tournaments/{tournament_id}/registrations/{id}

Authorized Access

Updates a registration by the given id. For status changes conditions, see this Registration guide.

Resource URL

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

HTTP headers

  • X-Api-Key
    string

    API key of your application (see Authentication)

  • Authorization
    string

    Access token with organizer:registration scope (see Authorization)

Path parameters

  • tournament_id
    string

    The id of the tournament containing the registration.

  • id
    string

    The unique identifier of the registration to retrieve.

Query Parameters

This endpoint does not have any query parameters.

Request Body

Data to provide for update the registration.

Example
{
    "name": "A team player name",
    "email": "player_1@team.com",
    "custom_user_identifier": "acme:account:1234",
    "custom_fields": {},
    "status": "pending",
    "lineup": [
        {
            "name": "A team player name",
            "email": "player_1@team.com",
            "custom_user_identifier": "acme:account:1234",
            "custom_fields": {}
        }
    ]
}
Structure (object)
  • name
    string

    The name of the registration.

    Max. length: 40 characters

    Example: "A team player name"

  • email
    string|null

    Optional

    The email of the team player.

    Max. length: 254 characters

    Example: "player_1@team.com"

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

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

  • status
    string

    Optional

    The status of the registration.

    Possible values: pending, accepted, refused, cancelled

  • lineup
    array[object]

    Optional

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

Response

[200] Regiostration updated.

Example
{
    "name": "A team player name",
    "email": "player_1@team.com",
    "custom_user_identifier": "acme:account:1234",
    "custom_fields": {},
    "id": "375143143408309123",
    "type": "team",
    "tournament_id": "378426939508809728",
    "participant_id": "375143143408309123",
    "user_id": "145246939508809147",
    "status": "pending",
    "lineup": [
        {
            "name": "A team player name",
            "email": "player_1@team.com",
            "custom_user_identifier": "acme:account:1234",
            "custom_fields": {},
            "user_id": "145246939508809147"
        }
    ]
}
Structure (object)
  • name
    string

    The name of the registration.

    Max. length: 40 characters

    Example: "A team player name"

  • email
    string|null

    The email of the team player.

    Max. length: 254 characters

    Example: "player_1@team.com"

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

  • 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 unique identifier of this registration.

    Example: "375143143408309123"

  • type
    string

    The type of participants that play in the tournament.

    Possible values: team, player

  • tournament_id
    string

    The id of the tournament.

    Example: "378426939508809728"

  • participant_id
    string|null

    The id of the participant.

    Example: "375143143408309123"

  • user_id
    string|null

    The identifier of the user associated to this registration.

    Example: "145246939508809147"

  • status
    string

    The status of the registration.

    Possible values: pending, accepted, refused, cancelled

  • lineup
    array[object]

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

DELETE /tournaments/{tournament_id}/registrations/{id}

Authorized Access

Deletes the registration with the given id in the tournament.

Resource URL

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

HTTP headers

  • X-Api-Key
    string

    API key of your application (see Authentication)

  • Authorization
    string

    Access token with organizer:registration scope (see Authorization)

Path parameters

  • tournament_id
    string

    The id of the tournament containing the registration.

  • id
    string

    The unique identifier of the registration 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