Skip to main content
POST
Get Character Inventory

Authorizations

X-SecretKey
string
header
required

This API requires a title secret key, available to title admins, from PlayFab Game Manager.

Body

application/json

All items currently in the character inventory will be returned, irrespective of how they were acquired (via purchasing, grants, coupons, etc.). Items that are expired, fully consumed, or are no longer valid are not considered to be in the user's current inventory, and so will not be not included. Also returns their virtual currency balances.

All items currently in the character inventory will be returned, irrespective of how they were acquired (via purchasing, grants, coupons, etc.). Items that are expired, fully consumed, or are no longer valid are not considered to be in the user's current inventory, and so will not be not included. Also returns their virtual currency balances.

CharacterId
string
required

Unique PlayFab assigned ID for a specific character owned by a user

PlayFabId
string
required

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

CatalogVersion
string

Used to limit results to only those from a specific catalog version.

CustomTags
object

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

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
Example:
Last modified on October 1, 2026