Participant API › Registrations Legacy

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

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 can not exceed 50. (see Pagination)

  Example: registrations=0-49

Query Parameters

• tournament_ids

  array

  List of tournament IDs to filter the data with.

  Example: 378426939508809728,534138941862841533

• playlist_ids

  array

  List of playlist IDs to filter the data with.

  Example: 123485236848698874,135864989139387313

Request Body

This endpoint does not require a request body.

Response

[206] Registrations retrieved.

Example

[
    {
        "lineup": [
            {
                "name": "A team player name",
                "email": "[email protected]",
                "custom_fields": {}
            }
        ],
        "id": "375143143408309123",
        "tournament_id": "378426939508809728",
        "participant_id": "375143143408309123",
        "type": "team",
        "status": "pending",
        "name": "A team player name",
        "custom_fields": {}
    }
]

Structure (collection)

• lineup

  array[object]

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

  • name

    string

    The name of the team player.

    Max. length: 40 characters

    Example: "A team player name"

  • email

    string

    The email of the team player.

    Max. length: 180 characters

    Example: "[email protected]"

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

• tournament_id

  string

  The id of the tournament.

  Example: "378426939508809728"

• participant_id

  string|null

  The id of the participant.

  Example: "375143143408309123"

• type

  string

  The type of participants that play in the tournament.

  Possible values: team, player

• status

  string

  The status of the registration.

  Possible values: pending, accepted, refused, cancelled

• name

  string

  The name of the registration.

  Max. length: 40 characters

  Example: "A team player name"

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

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

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 does not have any query parameters.

Request Body

New registration.

Example

{
    "name": "A team player name",
    "type": "team",
    "tournament_id": "378426939508809728",
    "custom_fields": {},
    "lineup": [
        {
            "name": "A team player name",
            "email": "[email protected]",
            "custom_fields": {}
        }
    ]
}

Structure (object)

• name

  string

  The name of the registration.

  Max. length: 40 characters

  Example: "A team player name"

• type

  string

  The type of participants that play in the tournament.

  Possible values: team, player

• tournament_id

  string

  The id of the tournament that contains this registration.

  Example: "378426939508809728"

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

  • name

    string

    Optional

    The name of the team player.

    Max. length: 40 characters

    Example: "A team player name"

  • email

    string

    Optional

    The email of the team player.

    Max. length: 180 characters

    Example: "[email protected]"

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

Response

[201] Registrations created.

Example

{
    "lineup": [
        {
            "name": "A team player name",
            "email": "[email protected]",
            "custom_fields": {}
        }
    ],
    "id": "375143143408309123",
    "tournament_id": "378426939508809728",
    "participant_id": "375143143408309123",
    "type": "team",
    "status": "pending",
    "name": "A team player name",
    "custom_fields": {}
}

Structure (object)

• lineup

  array[object]

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

  • name

    string

    The name of the team player.

    Max. length: 40 characters

    Example: "A team player name"

  • email

    string

    The email of the team player.

    Max. length: 180 characters

    Example: "[email protected]"

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

• tournament_id

  string

  The id of the tournament.

  Example: "378426939508809728"

• participant_id

  string|null

  The id of the participant.

  Example: "375143143408309123"

• type

  string

  The type of participants that play in the tournament.

  Possible values: team, player

• status

  string

  The status of the registration.

  Possible values: pending, accepted, refused, cancelled

• name

  string

  The name of the registration.

  Max. length: 40 characters

  Example: "A team player name"

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

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

Returns the registration with the given id on the condition that it is associated to the authenticated user, else the endpoint will return a 403 Error (Forbidden).

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 id 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

{
    "lineup": [
        {
            "name": "A team player name",
            "email": "[email protected]",
            "custom_fields": {}
        }
    ],
    "id": "375143143408309123",
    "tournament_id": "378426939508809728",
    "participant_id": "375143143408309123",
    "type": "team",
    "status": "pending",
    "name": "A team player name",
    "custom_fields": {}
}

Structure (object)

• lineup

  array[object]

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

  • name

    string

    The name of the team player.

    Max. length: 40 characters

    Example: "A team player name"

  • email

    string

    The email of the team player.

    Max. length: 180 characters

    Example: "[email protected]"

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

• tournament_id

  string

  The id of the tournament.

  Example: "378426939508809728"

• participant_id

  string|null

  The id of the participant.

  Example: "375143143408309123"

• type

  string

  The type of participants that play in the tournament.

  Possible values: team, player

• status

  string

  The status of the registration.

  Possible values: pending, accepted, refused, cancelled

• name

  string

  The name of the registration.

  Max. length: 40 characters

  Example: "A team player name"

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

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

Updates the registration with the given id on the condition that it is associated to the authenticated user, else the endpoint will return a 403 Error (Forbidden). For status changes conditions, see this Registration guide.

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 id of the registration to retrieve.

Query Parameters

This endpoint does not have any query parameters.

Request Body

Update registration.

Example

{
    "name": "A team player name",
    "tournament_id": "378426939508809728",
    "custom_fields": {},
    "lineup": [
        {
            "name": "A team player name",
            "email": "[email protected]",
            "custom_fields": {}
        }
    ]
}

Structure (object)

• name

  string

  Optional

  The name of the registration.

  Max. length: 40 characters

  Example: "A team player name"

• tournament_id

  string

  Optional

  The id of the tournament that contains this registration.

  Example: "378426939508809728"

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

  • name

    string

    Optional

    The name of the team player.

    Max. length: 40 characters

    Example: "A team player name"

  • email

    string

    Optional

    The email of the team player.

    Max. length: 180 characters

    Example: "[email protected]"

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

Response

[206] Update registration.

Example

[
    {
        "lineup": [
            {
                "name": "A team player name",
                "email": "[email protected]",
                "custom_fields": {}
            }
        ],
        "id": "375143143408309123",
        "tournament_id": "378426939508809728",
        "participant_id": "375143143408309123",
        "type": "team",
        "status": "pending",
        "name": "A team player name",
        "custom_fields": {}
    }
]

Structure (collection)

• lineup

  array[object]

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

  • name

    string

    The name of the team player.

    Max. length: 40 characters

    Example: "A team player name"

  • email

    string

    The email of the team player.

    Max. length: 180 characters

    Example: "[email protected]"

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

• tournament_id

  string

  The id of the tournament.

  Example: "378426939508809728"

• participant_id

  string|null

  The id of the participant.

  Example: "375143143408309123"

• type

  string

  The type of participants that play in the tournament.

  Possible values: team, player

• status

  string

  The status of the registration.

  Possible values: pending, accepted, refused, cancelled

• name

  string

  The name of the registration.

  Max. length: 40 characters

  Example: "A team player name"

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