Skip to main content
POST
Get Friend Leaderboard

Authorizations

X-SecretKey
string
header
required

This API requires a title secret key, available to title admins, from PlayFab Game Manager.

Body

application/json
MaxResultsCount
number
required

Maximum number of entries to retrieve.

PlayFabId
string
required

The player whose friend leaderboard to get

StartPosition
number
required

Position in the leaderboard to start this listing (defaults to the first entry).

StatisticName
string
required

Statistic used to rank friends for this leaderboard.

CustomTags
object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

ExternalPlatformFriends
enum<string>

Indicates which other platforms' friends should be included in the response. In HTTP, it is represented as a comma-separated list of platforms.

Available options:
None,
Steam,
Facebook,
Xbox,
Psn,
All
ProfileConstraints
object

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.

UseSpecificVersion
boolean

If set to false, Version is considered null. If true, uses the specified Version

Version
number

The version of the leaderboard to get.

XboxToken
string

Xbox token if Xbox friends should be included. Requires Xbox be configured on PlayFab.

Response

Note that the Position of the user in the results is for the overall leaderboard.

code
integer

The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code.

status
string

The Http status code as a string.

data
object

Note that the Position of the user in the results is for the overall leaderboard.

Example:
Last modified on October 1, 2026