Download Manual Download

Navigation Mobile menu

List Players on a Team

Overview

Returns all players currently registered on a team.

Request URL

All parameters in the request must be sent as a POST HTTP request. Make all requests to the following URL:

https://leaderboards.construct.net/listteamplayers.json

Authenticating The Request

No authentication is required for calling this end point.

secret string Optional: Your games secret API key.

Request Parameters

gameID guid Required: The ID of the game you are making this request against. You can find the ID of your game in your Construct Game Services (CGS) account.
leaderboardID guid Required: The ID of the leaderboard you're fetching team players from.
teamID guid Required: The ID of the team you're fetching players from.
order string: Order method to return players in. Permitted values are PlayerName or Score. Defaults to PlayerName if not specified.
perPage int32: How many players you wish to return on each page of results. Cannot be less than 1 or more than 50. Default value is 10.
page int32: The page of results you are requesting. The first page is always 1. If this value is not specified the first page will be returned.
culture string Optional: Optionally specify a supported culture code for rendering various properties. If not specified, the culture code from your games default language will be used.

Success Response

Successful responses always return a HTTP 200 status code.

{
  "success": true,
  "pagination": { ... },
  "players": [
    { ... },
    { ... }
  ],
  "team": { ... },
  "formattingCulture": "en-us"
}

Response Properties

success bool: If the request was successfull or not.
pagination Pagination: A pagination object helpful for navigating other pages of results.
players Array<TeamPlayer>: The list of players returned in the request.
team ExpandedTeam: The team object these players belong to.
formattingCulture string: If some return values are culture specific, this property indicates what culture the values have been rendered as.

Failure Response

Unsuccessful responses always return HTTP 4xx status codes.

{
  "success": false,
  "errorMessage": "Your request failed due to...",
  "helpURL": "https://www.construct.net/en/game-services/manuals/game-services/leaderboards/api-end-points/teams/list-team-players",
  "shouldRetry": false
}

Response Properties

success bool: If the request was successfull or not.
errorMessage string: An error message with more detailed information on why the request failed.
helpURL url (string): A link to documentation which should provide help with the error.
shouldRetry bool: Should the client wait a short period of time and retry the request. Usually this is false, but returns true if the request failed due to rate limiting.