Sign in

v1

latestSwagger 2.02026-07-14280390.8 KB

Halo 5 - Leaderboard - Player CSR

Retrieves the Leaderboard for Player CSRs. The Leaderboard consists of the top Players with a CSR of 1800 or above for a given Playlist in a Season.

Changelog

March 6, 2018:

  • Fixed documentation typos for the names of the "Player" and "Gamertag" properties.

July 31, 2017:

  • Clarified documentation for which players are included in the leaderboard.

February 21, 2017:

  • Renamed Endpoint from "Player Leaderboard" to "Halo 5 - Leaderboard Player CSR".
  • Removed "{title}" Request Parameter.

April 20, 2016:

  • Added Endpoint.
get/h5/player-leaderboards/csr/{seasonId}/{playlistId}

Path parameters

seasonIdstring required

The ID for the Season.

playlistIdstring required

The ID for the Playlist.

Query parameters

countnumber

When specified, this indicates the maximum quantity of items the client would like returned in the response.

When omitted, 200 is assumed.

When the value contains a non-digit or is exactly "0", HTTP 400 ("Bad Request") is returned.

When the value is greater than the allowed range [1,250], the maximum allowed value is used instead.

The "Count" field in the response will confirm the actual value that was used.

Response

The response body will contain the Players in the Leaderboard. An empty list will be returned if no Players are in the Leaderboard.