Platform API › Team Members

Retrieves all members of a team. Members are always listed by creation date (ascending order).

Resource URL

https://api.toornament.com/platform/v2/teams/{teamId}/members

HTTP headers

• X-Api-Key

  string

  API key of your application (see Authentication)

• Authorization

  string

  Access token with platform:team scope (see Authorization)

Path parameters

• team_id

  string

  The id of the team you want to retrieve data about.

Query Parameters

This endpoint does not have any query parameters.

Request Body

This endpoint does not require a request body.

Response

[200] Success

Example

[
    {
        "user": {
            "id": "475141143408399456",
            "nickname": "Pokap"
        }
    }
]

Structure (collection)

• user

  object

  User associated to the team member.

  • id

    string

    Id of the user.

    Example: "475141143408399456"

  • nickname

    string

    Name of the user.

    Max. length: 40 characters

    Example: "Pokap"

Add a new member to a team.

Resource URL

https://api.toornament.com/platform/v2/teams/{teamId}/members

HTTP headers

• X-Api-Key

  string

  API key of your application (see Authentication)

• Authorization

  string

  Access token with platform:team scope (see Authorization)

Query Parameters

This endpoint does not have any query parameters.

Request Body

Data to provide to create a new member in a team.

Example

{
    "user": {
        "id": "475141143408399456"
    }
}

Structure (object)

• user

  object

  User to add in the team.

  • id

    string

    Id of the user.

    Example: "475141143408399456"

Response

[201] Success.

Example

{
    "user": {
        "id": "475141143408399456",
        "nickname": "Pokap"
    }
}

Structure (object)

• user

  object

  User associated to the team member.

  • id

    string

    Id of the user.

    Example: "475141143408399456"

  • nickname

    string

    Name of the user.

    Max. length: 40 characters

    Example: "Pokap"

Returns a single member of a team.

Resource URL

https://api.toornament.com/platform/v2/teams/{teamId}/members/{id}

HTTP headers

• X-Api-Key

  string

  API key of your application (see Authentication)

• Authorization

  string

  Access token with platform:team scope (see Authorization)

Path parameters

• team_id

  string

  The id of the team you want to retrieve data about.

• id

  string

  The id of the requested member.

Query Parameters

This endpoint does not have any query parameters.

Request Body

This endpoint does not require a request body.

Response

[200] Success

Example

{
    "user": {
        "id": "475141143408399456",
        "nickname": "Pokap"
    }
}

Structure (object)

• user

  object

  User associated to the team member.

  • id

    string

    Id of the user.

    Example: "475141143408399456"

  • nickname

    string

    Name of the user.

    Max. length: 40 characters

    Example: "Pokap"

Deletes a single member from the team.

Resource URL

https://api.toornament.com/platform/v2/teams/{teamId}/members/{id}

HTTP headers

• X-Api-Key

  string

  API key of your application (see Authentication)

• Authorization

  string

  Access token with platform:team scope (see Authorization)

Path parameters

• team_id

  string

  The id of the team you want to retrieve data about.

• id

  string

  The id of the requested member.

Query Parameters

• kicked

  integer

  Whether to notify the user of his eviction.

  Possible values: 0, 1

  Default: 0

Request Body

This endpoint does not require a request body.

Response

[204] Success