Registrations | Organizer API | API v2.0

Endpoints

GET /registrations
Retrieves all registrations of all your tournaments.
POST /registrations
Create a new registration.
GET /registrations/{id}
Retrieves a registration.
PATCH /registrations/{id}
Updates a registration.
DELETE /registrations/{id}
Deletes a registration.
LegacyGET /tournaments/{tournament_id}/registrations
Retrieve the registrations of a tournament.
LegacyPOST /tournaments/{tournament_id}/registrations
Create a new registration in a tournament.
LegacyGET /tournaments/{tournament_id}/registrations/{id}
Retrieve a registration of a tournament.
LegacyPATCH /tournaments/{tournament_id}/registrations/{id}
Update a registration.
LegacyDELETE /tournaments/{tournament_id}/registrations/{id}
Delete a registration from a tournament.

GET /registrations

Retrieves all registrations of all your tournaments.

Resource URL

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

Query Parameters

tournament_ids
array
Only return registrations for the given list of tournaments.
Example: 378426939508809728,534138941862841533
statuses
array
One or several registrations statuses to filter.
Possible values: pending, accepted, cancelled, refused
Example: pending,accepted
user_ids
array
Only return registrations for the given list of player user ids.
Example: 475141143408399456,735147043408391234
team_ids
array
Only return registrations for the given list of team ids.
Example: 561714159547269773,255149043401714321
custom_user_identifiers
array
A list of external custom user identifiers.
Example: acme:account:1234,acme:account:1235
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

[
    {
        "lineup": [
            {
                "name": "A team player name",
                "email": "[email protected]",
                "user_id": "145246939508809147",
                "custom_user_identifier": "acme:account:1234",
                "custom_fields": {}
            }
        ],
        "id": "375143143408309123",
        "tournament_id": "378426939508809728",
        "participant_id": "375143143408309123",
        "user_id": "145246939508809147",
        "custom_user_identifier": "acme:account:1234",
        "email": "[email protected]",
        "type": "team",
        "status": "pending",
        "name": "A team player name",
        "custom_fields": {},
        "created_at": "2015-12-09T13:37:42+00:00"
    }
]

Structure (collection)

lineup
array[object]
A list of players in a team (Only if the tournament participant type is “team”).
- name
  string|null
  The name of the team player.
  Max. length: 40 characters
  Example: "A team player name"
- email
  string|null
  The email of the team player.
  Max. length: 180 characters
  Example: "[email protected]"
- user_id
  string|null
  The identifier of the user associated to this registration.
  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"
- 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"
user_id
string|null
The identifier of the user associated to this registration.
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"
email
string|null
The email of the team player.
Max. length: 180 characters
Example: "[email protected]"
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: {}
created_at
string
The date and time of the registration creation, in RFC 3339 format (combined date, time and utc offset).
Format: datetime
Example: "2015-12-09T13:37:42+00:00"

POST /registrations

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

HTTP headers

X-Api-Key
string
API key of your application (see Authentication)
Authorization
string
Access token with organizer:registration scope (see Authorization)

Query Parameters

custom_field_required
integer
Allow required custom fields empty
Possible values: 0, 1
Default: 0

Request Body

Data to provide to create the registration.

Example

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

Structure (object)

tournament_id
string
The id of the tournament.
Example: "378426939508809728"
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
email
string|null
Optional
The email of the team player.
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"
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|null
  Optional
  The name of the team player.
  Max. length: 40 characters
  Example: "A team player name"
- email
  string|null
  Optional
  The email of the team player.
  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"
- 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] Registration created

Example

{
    "lineup": [
        {
            "name": "A team player name",
            "email": "[email protected]",
            "user_id": "145246939508809147",
            "custom_user_identifier": "acme:account:1234",
            "custom_fields": {}
        }
    ],
    "id": "375143143408309123",
    "tournament_id": "378426939508809728",
    "participant_id": "375143143408309123",
    "user_id": "145246939508809147",
    "custom_user_identifier": "acme:account:1234",
    "email": "[email protected]",
    "type": "team",
    "status": "pending",
    "name": "A team player name",
    "custom_fields": {},
    "created_at": "2015-12-09T13:37:42+00:00"
}

Structure (object)

lineup
array[object]
A list of players in a team (Only if the tournament participant type is “team”).
- name
  string|null
  The name of the team player.
  Max. length: 40 characters
  Example: "A team player name"
- email
  string|null
  The email of the team player.
  Max. length: 180 characters
  Example: "[email protected]"
- user_id
  string|null
  The identifier of the user associated to this registration.
  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"
- 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"
user_id
string|null
The identifier of the user associated to this registration.
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"
email
string|null
The email of the team player.
Max. length: 180 characters
Example: "[email protected]"
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: {}
created_at
string
The date and time of the registration creation, in RFC 3339 format (combined date, time and utc offset).
Format: datetime
Example: "2015-12-09T13:37:42+00:00"

GET /registrations/{id}

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

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

{
    "lineup": [
        {
            "name": "A team player name",
            "email": "[email protected]",
            "user_id": "145246939508809147",
            "custom_user_identifier": "acme:account:1234",
            "custom_fields": {}
        }
    ],
    "id": "375143143408309123",
    "tournament_id": "378426939508809728",
    "participant_id": "375143143408309123",
    "user_id": "145246939508809147",
    "custom_user_identifier": "acme:account:1234",
    "email": "[email protected]",
    "type": "team",
    "status": "pending",
    "name": "A team player name",
    "custom_fields": {},
    "created_at": "2015-12-09T13:37:42+00:00"
}

Structure (object)

lineup
array[object]
A list of players in a team (Only if the tournament participant type is “team”).
- name
  string|null
  The name of the team player.
  Max. length: 40 characters
  Example: "A team player name"
- email
  string|null
  The email of the team player.
  Max. length: 180 characters
  Example: "[email protected]"
- user_id
  string|null
  The identifier of the user associated to this registration.
  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"
- 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"
user_id
string|null
The identifier of the user associated to this registration.
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"
email
string|null
The email of the team player.
Max. length: 180 characters
Example: "[email protected]"
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: {}
created_at
string
The date and time of the registration creation, in RFC 3339 format (combined date, time and utc offset).
Format: datetime
Example: "2015-12-09T13:37:42+00:00"

PATCH /registrations/{id}

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

Resource URL

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

id
string
The unique identifier of the registration to retrieve.

Query Parameters

custom_field_required
integer
Allow required custom fields empty
Possible values: 0, 1
Default: 0

Request Body

Data to provide for update the registration.

Example

{
    "name": "A team player name",
    "email": "[email protected]",
    "custom_user_identifier": "acme:account:1234",
    "custom_fields": {},
    "status": "pending",
    "lineup": [
        {
            "name": "A team player name",
            "email": "[email protected]",
            "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: 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"
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”).
- name
  string|null
  Optional
  The name of the team player.
  Max. length: 40 characters
  Example: "A team player name"
- email
  string|null
  Optional
  The email of the team player.
  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"
- 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

[200] Registration updated.

Example

{
    "lineup": [
        {
            "name": "A team player name",
            "email": "[email protected]",
            "user_id": "145246939508809147",
            "custom_user_identifier": "acme:account:1234",
            "custom_fields": {}
        }
    ],
    "id": "375143143408309123",
    "tournament_id": "378426939508809728",
    "participant_id": "375143143408309123",
    "user_id": "145246939508809147",
    "custom_user_identifier": "acme:account:1234",
    "email": "[email protected]",
    "type": "team",
    "status": "pending",
    "name": "A team player name",
    "custom_fields": {},
    "created_at": "2015-12-09T13:37:42+00:00"
}

Structure (object)

lineup
array[object]
A list of players in a team (Only if the tournament participant type is “team”).
- name
  string|null
  The name of the team player.
  Max. length: 40 characters
  Example: "A team player name"
- email
  string|null
  The email of the team player.
  Max. length: 180 characters
  Example: "[email protected]"
- user_id
  string|null
  The identifier of the user associated to this registration.
  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"
- 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"
user_id
string|null
The identifier of the user associated to this registration.
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"
email
string|null
The email of the team player.
Max. length: 180 characters
Example: "[email protected]"
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: {}
created_at
string
The date and time of the registration creation, in RFC 3339 format (combined date, time and utc offset).
Format: datetime
Example: "2015-12-09T13:37:42+00:00"

DELETE /registrations/{id}

Deletes a registration identified by the given id.

Resource URL

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

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

LegacyGET /tournaments/{tournament_id}/registrations

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

[
    {
        "lineup": [
            {
                "name": "A team player name",
                "email": "[email protected]",
                "user_id": "145246939508809147",
                "custom_user_identifier": "acme:account:1234",
                "custom_fields": {}
            }
        ],
        "id": "375143143408309123",
        "tournament_id": "378426939508809728",
        "participant_id": "375143143408309123",
        "user_id": "145246939508809147",
        "custom_user_identifier": "acme:account:1234",
        "email": "[email protected]",
        "type": "team",
        "status": "pending",
        "name": "A team player name",
        "custom_fields": {},
        "created_at": "2015-12-09T13:37:42+00:00"
    }
]

Structure (collection)

lineup
array[object]
A list of players in a team (Only if the tournament participant type is “team”).
- name
  string|null
  The name of the team player.
  Max. length: 40 characters
  Example: "A team player name"
- email
  string|null
  The email of the team player.
  Max. length: 180 characters
  Example: "[email protected]"
- user_id
  string|null
  The identifier of the user associated to this registration.
  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"
- 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"
user_id
string|null
The identifier of the user associated to this registration.
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"
email
string|null
The email of the team player.
Max. length: 180 characters
Example: "[email protected]"
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: {}
created_at
string
The date and time of the registration 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}/registrations

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. 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 to create the registration.

Example

{
    "name": "A team player name",
    "type": "team",
    "email": "[email protected]",
    "custom_user_identifier": "acme:account:1234",
    "custom_fields": {},
    "lineup": [
        {
            "name": "A team player name",
            "email": "[email protected]",
            "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"
type
string
The type of participants that play in the tournament.
Possible values: team, player
email
string|null
Optional
The email of the team player.
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"
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|null
  Optional
  The name of the team player.
  Max. length: 40 characters
  Example: "A team player name"
- email
  string|null
  Optional
  The email of the team player.
  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"
- 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] Registration created

Example

{
    "lineup": [
        {
            "name": "A team player name",
            "email": "[email protected]",
            "user_id": "145246939508809147",
            "custom_user_identifier": "acme:account:1234",
            "custom_fields": {}
        }
    ],
    "id": "375143143408309123",
    "tournament_id": "378426939508809728",
    "participant_id": "375143143408309123",
    "user_id": "145246939508809147",
    "custom_user_identifier": "acme:account:1234",
    "email": "[email protected]",
    "type": "team",
    "status": "pending",
    "name": "A team player name",
    "custom_fields": {},
    "created_at": "2015-12-09T13:37:42+00:00"
}

Structure (object)

lineup
array[object]
A list of players in a team (Only if the tournament participant type is “team”).
- name
  string|null
  The name of the team player.
  Max. length: 40 characters
  Example: "A team player name"
- email
  string|null
  The email of the team player.
  Max. length: 180 characters
  Example: "[email protected]"
- user_id
  string|null
  The identifier of the user associated to this registration.
  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"
- 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"
user_id
string|null
The identifier of the user associated to this registration.
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"
email
string|null
The email of the team player.
Max. length: 180 characters
Example: "[email protected]"
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: {}
created_at
string
The date and time of the registration 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}/registrations/{id}

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

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

{
    "lineup": [
        {
            "name": "A team player name",
            "email": "[email protected]",
            "user_id": "145246939508809147",
            "custom_user_identifier": "acme:account:1234",
            "custom_fields": {}
        }
    ],
    "id": "375143143408309123",
    "tournament_id": "378426939508809728",
    "participant_id": "375143143408309123",
    "user_id": "145246939508809147",
    "custom_user_identifier": "acme:account:1234",
    "email": "[email protected]",
    "type": "team",
    "status": "pending",
    "name": "A team player name",
    "custom_fields": {},
    "created_at": "2015-12-09T13:37:42+00:00"
}

Structure (object)

lineup
array[object]
A list of players in a team (Only if the tournament participant type is “team”).
- name
  string|null
  The name of the team player.
  Max. length: 40 characters
  Example: "A team player name"
- email
  string|null
  The email of the team player.
  Max. length: 180 characters
  Example: "[email protected]"
- user_id
  string|null
  The identifier of the user associated to this registration.
  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"
- 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"
user_id
string|null
The identifier of the user associated to this registration.
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"
email
string|null
The email of the team player.
Max. length: 180 characters
Example: "[email protected]"
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: {}
created_at
string
The date and time of the registration 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}/registrations/{id}

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

Updates a registration identified 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": "[email protected]",
    "custom_user_identifier": "acme:account:1234",
    "custom_fields": {},
    "status": "pending",
    "lineup": [
        {
            "name": "A team player name",
            "email": "[email protected]",
            "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: 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"
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”).
- name
  string|null
  Optional
  The name of the team player.
  Max. length: 40 characters
  Example: "A team player name"
- email
  string|null
  Optional
  The email of the team player.
  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"
- 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

[200] Regiostration updated.

Example

{
    "lineup": [
        {
            "name": "A team player name",
            "email": "[email protected]",
            "user_id": "145246939508809147",
            "custom_user_identifier": "acme:account:1234",
            "custom_fields": {}
        }
    ],
    "id": "375143143408309123",
    "tournament_id": "378426939508809728",
    "participant_id": "375143143408309123",
    "user_id": "145246939508809147",
    "custom_user_identifier": "acme:account:1234",
    "email": "[email protected]",
    "type": "team",
    "status": "pending",
    "name": "A team player name",
    "custom_fields": {},
    "created_at": "2015-12-09T13:37:42+00:00"
}

Structure (object)

lineup
array[object]
A list of players in a team (Only if the tournament participant type is “team”).
- name
  string|null
  The name of the team player.
  Max. length: 40 characters
  Example: "A team player name"
- email
  string|null
  The email of the team player.
  Max. length: 180 characters
  Example: "[email protected]"
- user_id
  string|null
  The identifier of the user associated to this registration.
  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"
- 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"
user_id
string|null
The identifier of the user associated to this registration.
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"
email
string|null
The email of the team player.
Max. length: 180 characters
Example: "[email protected]"
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: {}
created_at
string
The date and time of the registration 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}/registrations/{id}

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

Deletes the registration identified by the given id.

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.