Download Manual Download

Navigation Mobile menu

Get Teams

Overview

Retrieve all teams, ordered by the highest rank.

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/getteams.json

Authenticating The Request

No authentication is required for calling this end point, however you can optionally pass a secret key to this request. You may need to do this if you've set your game to require a secret key for GET or POST requests for this service.

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 teams from.
perPage int32: How many teams you wish to return on each page of results. Cannot be less than 1 or more than 100. Default value is 20.
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": { ... },
  "teams": [
    { ... },
    { ... }
  ],
  "formattingCulture": "en-us",
  "responseLanguage": {
    "iso": "EN",
    "englishName": "English"
  }
}

Response Properties

success bool: If the request was successfull or not.
pagination Pagination: A pagination object helpful for navigating other pages of results.
teams Array<ExpandedTeam>: The list of team objects returned from the request.
formattingCulture string: If some return values are culture specific, this property indicates what culture the values have been rendered as.
responseLanguage Language: The language of translatable elements in the response. If this is different to the requested language, then it is likely your plan has run out of translation credits.

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/get-teams",
  "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.