Characters

Characters APIs

Operations

Get All Users Characters

Lists all of the characters that belong to a specific user. CharacterIds are not globally unique; characterId must be evaluated with the parent PlayFabId to guarantee uniqueness.

Get Character Leaderboard

Retrieves a list of ranked characters for the given statistic, starting from the indicated point in the leaderboard

Get Character Statistics

Retrieves the details of all title-specific statistics for the user

Get Leaderboard Around Character

Retrieves a list of ranked characters for the given statistic, centered on the requested Character ID

Get Leaderboard For User Characters

Retrieves a list of all of the user's characters for the given statistic.

Grant Character To User

Grants the specified character type to the user. CharacterIds are not globally unique; characterId must be evaluated with the parent PlayFabId to guarantee uniqueness.

Update Character Statistics

Updates the values of the specified title-specific statistics for the specific character. By default, clients are not permitted to update statistics. Developers may override this setting in the Game Manager > Settings > API Features.