Skip to main content
POST
Get Friend Leaderboard Around Player

Authorizations

X-Authorization
string
header
required

This API requires a client session ticket, available from any Client Login function.

Body

application/json
StatisticName
string
required

Statistic used to rank players 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
MaxResultsCount
number

Maximum number of entries to retrieve. Default 10, maximum 100.

PlayFabId
string

PlayFab unique identifier of the user to center the leaderboard around. If null will center on the logged in user.

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: When calling 'GetLeaderboardAround...' APIs, the position of the user defaults to 0 when the user does not have the corresponding statistic.If Facebook friends are included, make sure the access token from previous LoginWithFacebook call is still valid and not expired. If Xbox Live friends are included, make sure the access token from the previous LoginWithXbox call is still valid and not expired.

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: When calling 'GetLeaderboardAround...' APIs, the position of the user defaults to 0 when the user does not have the corresponding statistic.If Facebook friends are included, make sure the access token from previous LoginWithFacebook call is still valid and not expired. If Xbox Live friends are included, make sure the access token from the previous LoginWithXbox call is still valid and not expired.

Example:
Last modified on October 1, 2026