Get Friend Leaderboard
Retrieves a list of ranked friends of the current player for the given statistic, starting from the indicated point in the leaderboard
Error codes
This operation may return the following PlayFab errors:
| Error | Code |
|---|---|
| ExpiredXboxLiveToken | 1189 |
| FacebookAPIError | 1143 |
| InvalidXboxLiveToken | 1188 |
| LeaderboardVersionNotAvailable | 1277 |
| ProductDisabledForTitle | 1609 |
| XboxInaccessible | 1339 |
| XboxServiceTooManyRequests | 1505 |
| XboxXASSExchangeFailure | 1306 |
Authorizations
This API requires a client session ticket, available from any Client Login function.
Body
Position in the leaderboard to start this listing (defaults to the first entry).
Statistic used to rank friends for this leaderboard.
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
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 Maximum number of entries to retrieve. Default 10, maximum 100.
If non-null, this determines which properties of the resulting player profiles to return. For API calls from the client, only the allowed client profile properties for the title may be requested. These allowed properties are configured in the Game Manager "Client Profile Options" tab in the "Settings" section.
If set to false, Version is considered null. If true, uses the specified Version
The version of the leaderboard to get.
Xbox token if Xbox friends should be included. Requires Xbox be configured on PlayFab.
Response
Note: the user's Position is relative to the overall leaderboard.
