Documentation

GetAllUsersCharacters

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.

Request Details

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

ListUsersCharactersRequest
Request Properties
PlayFabId String

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

POST https://{{TitleID}}.playfabapi.com/Client/GetAllUsersCharacters
    Content-Type: application/json
    X-Authentication: <user_session_ticket_value>
{
  "PlayFabId": "98333765432"
}
        

Response Details

ListUsersCharactersResult
Result Properties
Characters List<CharacterResult>

The requested list of characters.

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
  "code": 200,
  "status": "OK",
  "data": {
    "Characters": [
      {
        "CharacterId": "3345677",
        "CharacterName": "CoolDude",
        "CharacterType": "StrongWarrior"
      }
    ]
  }
}

Authentication

SessionTicket

Possible Error Codes

Name Code