Get Friend Leaderboard For Entity
Get the friend leaderboard for the specified entity. A maximum of 25 friend entries are listed in the leaderboard.
Allowed entity token types: title, title_player_account, game_server
Error codes
This operation may return the following PlayFab errors:
| Error | Code |
|---|---|
| AccountNotFound | 1001 |
| ApiNotEnabledForTitle | 1520 |
| DownstreamServiceUnavailable | 1127 |
| ExpiredXboxLiveToken | 1189 |
| FacebookAPIError | 1143 |
| InvalidEntityType | 1373 |
| InvalidSignature | 1273 |
| InvalidSignatureTime | 1324 |
| InvalidXboxLiveToken | 1188 |
| LeaderboardNotFound | 1567 |
| NoLeaderboardForStatistic | 1421 |
| PlayerSecretNotConfigured | 1323 |
| SpecifiedVersionLeaderboardNotFound | 1583 |
| StatisticNotFound | 1195 |
| XboxInaccessible | 1339 |
| XboxServiceTooManyRequests | 1505 |
| XboxXASSExchangeFailure | 1306 |
Authorizations
This API requires an Entity Session Token, available from the Entity GetEntityToken method.
Body
Name of the leaderboard.
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
The optional entity to perform this action on. Defaults to the currently logged in entity.
Indicates which other platforms' friends should be included in the response. In HTTP, it is represented as a comma-separated list of platforms.
None, Steam, Facebook, Xbox, Psn, All Optional version of the leaderboard, defaults to current version.
Xbox token if Xbox friends should be included. Requires Xbox be configured on PlayFab.
