Characters - 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.

POST https://titleId.playfabapi.com/Client/GetAllUsersCharacters

Request Body

Name Type Description
PlayFabId
  • string

Unique PlayFab assigned ID of the user on whom the operation will be performed.

Responses

Name Type Description
200 OK
400 Bad Request

This is the outer wrapper for all responses with errors

Security

SessionTicket

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

Type: apiKey
In: header

Definitions

ApiErrorWrapper

The basic wrapper around every failed API response

CharacterResult
ListUsersCharactersRequest

Returns a list of every character that currently belongs to a user.

ListUsersCharactersResult

ApiErrorWrapper

The basic wrapper around every failed API response

Name Type Description
code
  • integer

Numerical HTTP code

error
  • string

Playfab error code

errorCode
  • integer

Numerical PlayFab error code

errorDetails
  • object

Detailed description of individual issues with the request object

errorMessage
  • string

Description for the PlayFab errorCode

status
  • string

String HTTP code

CharacterResult

Name Type Description
CharacterId
  • string

The id for this character on this player.

CharacterName
  • string

The name of this character.

CharacterType
  • string

The type-string that was given to this character on creation.

ListUsersCharactersRequest

Returns a list of every character that currently belongs to a user.

Name Type Description
PlayFabId
  • string

Unique PlayFab assigned ID of the user on whom the operation will be performed.

ListUsersCharactersResult

Name Type Description
Characters

The requested list of characters.