Skip to main content
POST
Get Friend Leaderboard For Entity

Authorizations

X-EntityToken
string
header
required

This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Body

application/json
LeaderboardName
string
required

Name of the leaderboard.

CustomTags
object

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

Entity
object

The optional entity to perform this action on. Defaults to the currently logged in entity.

ExternalFriendSources
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
Version
number

Optional version of the leaderboard, defaults to current version.

XboxToken
string

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

Response

Leaderboard response

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

Leaderboard response

Example:
Last modified on October 1, 2026