Tournament API › Final Standings

Returns a list of final standing items.

Resource URL

https://api.toornament.com/organizer/v2/standing-items

HTTP headers

• X-Api-Key

  string

  API key of your application (see Authentication)

• Authorization

  string

  Access token with organizer:result scope (see Authorization)

• Range

  string

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

  Example: items=0-49

Query Parameters

• tournament_ids

  array

  Only return items for the given list of ids.

  Example: 378426939508809728,534138941862841533

• user_ids

  array

  One or several player user ids involved in the standings to filter.

  Example: 475141143408399456,735147043408391234

• team_ids

  array

  One or several team ids involved in the standings to filter.

  Example: 561714159547269773,255149043401714321

• custom_user_identifiers

  array

  A list of external custom user identifiers.

  Example: acme:account:1234,acme:account:1235

• participant_ids

  array

  One or several participant ids involved in the standings to filter.

  Example: 618965416546776434,618975467354349191

• min_rank

  integer

  A minimal rank to filter.

• max_rank

  integer

  A maximal rank to filter.

Request Body

This endpoint does not require a request body.

Response

[206] Standing items retrieved.

Example

[
    {
        "id": "378426939508809728",
        "tournament_id": "378426939508809728",
        "participant": {
            "id": "375143143408309123",
            "name": "Jon Snow",
            "custom_user_identifier": "acme:account:1234",
            "custom_fields": {}
        },
        "rank": 3,
        "position": 4
    }
]

Structure (collection)

• id

  string

  A unique identifier for the standing item.

  Example: "378426939508809728"

• tournament_id

  string

  The id of the tournament.

  Example: "378426939508809728"

• participant

  object|null

  The participant identified with this standing item.

  • id

    string

    The id of the participant.

    Example: "375143143408309123"

  • name

    string

    The name of the participant.

    Max. length: 40 characters

    Example: "Jon Snow"

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

• rank

  integer

  The ranking of the participant in the standing. Multiple participants can share the same rank if they are tied after involving all configured tiebreakers.

  Example: 3

• position

  integer

  A position used for presentation purposes. It is always unique within the same standing.

  Example: 4

Creates a new standing item. The position is recalculated according to the rank.

Resource URL

https://api.toornament.com/organizer/v2/standing-items

HTTP headers

• X-Api-Key

  string

  API key of your application (see Authentication)

• Authorization

  string

  Access token with organizer:result scope (see Authorization)

Query Parameters

This endpoint does not have any query parameters.

Request Body

Standing item data.

Example

{
    "tournament_id": "378426939508809728",
    "participant_id": "375143143408309123",
    "rank": 3,
    "position": 4
}

Structure (object)

• tournament_id

  string

  The id of the tournament.

  Example: "378426939508809728"

• participant_id

  string|null

  The id of the participant.

  Example: "375143143408309123"

• rank

  integer

  The ranking of the participant in the standing. Multiple participants can share the same rank if they are tied after involving all configured tiebreakers.

  Example: 3

• position

  integer

  Optional

  A position used for presentation purposes. It is always unique within the same standing.

  Example: 4

Response

[201] Success

Example

{
    "id": "378426939508809728",
    "tournament_id": "378426939508809728",
    "participant": {
        "id": "375143143408309123",
        "name": "Jon Snow",
        "custom_user_identifier": "acme:account:1234",
        "custom_fields": {}
    },
    "rank": 3,
    "position": 4
}

Structure (object)

• id

  string

  A unique identifier for the standing item.

  Example: "378426939508809728"

• tournament_id

  string

  The id of the tournament.

  Example: "378426939508809728"

• participant

  object|null

  The participant identified with this standing item.

  • id

    string

    The id of the participant.

    Example: "375143143408309123"

  • name

    string

    The name of the participant.

    Max. length: 40 characters

    Example: "Jon Snow"

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

• rank

  integer

  The ranking of the participant in the standing. Multiple participants can share the same rank if they are tied after involving all configured tiebreakers.

  Example: 3

• position

  integer

  A position used for presentation purposes. It is always unique within the same standing.

  Example: 4

Retrieve a single standing item.

Resource URL

https://api.toornament.com/organizer/v2/standing-items/{id}

HTTP headers

• X-Api-Key

  string

  API key of your application (see Authentication)

• Authorization

  string

  Access token with organizer:result scope (see Authorization)

Path parameters

• id

  string

  The id of the standing item to retrieve.

Query Parameters

This endpoint does not have any query parameters.

Request Body

This endpoint does not require a request body.

Response

[200] Standing item retrieved.

Example

{
    "id": "378426939508809728",
    "tournament_id": "378426939508809728",
    "participant": {
        "id": "375143143408309123",
        "name": "Jon Snow",
        "custom_user_identifier": "acme:account:1234",
        "custom_fields": {}
    },
    "rank": 3,
    "position": 4
}

Structure (object)

• id

  string

  A unique identifier for the standing item.

  Example: "378426939508809728"

• tournament_id

  string

  The id of the tournament.

  Example: "378426939508809728"

• participant

  object|null

  The participant identified with this standing item.

  • id

    string

    The id of the participant.

    Example: "375143143408309123"

  • name

    string

    The name of the participant.

    Max. length: 40 characters

    Example: "Jon Snow"

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

• rank

  integer

  The ranking of the participant in the standing. Multiple participants can share the same rank if they are tied after involving all configured tiebreakers.

  Example: 3

• position

  integer

  A position used for presentation purposes. It is always unique within the same standing.

  Example: 4

Updates the standing item with the given id. The position is recalculated according to the rank.

Resource URL

https://api.toornament.com/organizer/v2/standing-items/{id}

HTTP headers

• X-Api-Key

  string

  API key of your application (see Authentication)

• Authorization

  string

  Access token with organizer:result scope (see Authorization)

Path parameters

• id

  string

  The id of the standing item to retrieve.

Query Parameters

This endpoint does not have any query parameters.

Request Body

Standing item data.

Example

{
    "rank": 3,
    "position": 4,
    "participant_id": "375143143408309123"
}

Structure (object)

• rank

  integer

  Optional

  The ranking of the participant in the standing. Multiple participants can share the same rank if they are tied after involving all configured tiebreakers.

  Example: 3

• position

  integer

  Optional

  A position used for presentation purposes. It is always unique within the same standing.

  Example: 4

• participant_id

  string|null

  Optional

  The id of the participant.

  Example: "375143143408309123"

Response

[200] Standing item update.

Example

{
    "id": "378426939508809728",
    "tournament_id": "378426939508809728",
    "participant": {
        "id": "375143143408309123",
        "name": "Jon Snow",
        "custom_user_identifier": "acme:account:1234",
        "custom_fields": {}
    },
    "rank": 3,
    "position": 4
}

Structure (object)

• id

  string

  A unique identifier for the standing item.

  Example: "378426939508809728"

• tournament_id

  string

  The id of the tournament.

  Example: "378426939508809728"

• participant

  object|null

  The participant identified with this standing item.

  • id

    string

    The id of the participant.

    Example: "375143143408309123"

  • name

    string

    The name of the participant.

    Max. length: 40 characters

    Example: "Jon Snow"

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

• rank

  integer

  The ranking of the participant in the standing. Multiple participants can share the same rank if they are tied after involving all configured tiebreakers.

  Example: 3

• position

  integer

  A position used for presentation purposes. It is always unique within the same standing.

  Example: 4

Deletes a standing item identified by the given id.

Resource URL

https://api.toornament.com/organizer/v2/standing-items/{id}

HTTP headers

• X-Api-Key

  string

  API key of your application (see Authentication)

• Authorization

  string

  Access token with organizer:result scope (see Authorization)

Path parameters

• id

  string

  The id of the standing item 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