Account Management - Get Account Info

Retrieves the user's PlayFab account details

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

Request Body

Name Type Description
Email
  • string

User email address for the account to find (if no Username is specified).

PlayFabId
  • string

Unique PlayFab identifier of the user whose info is being requested. Optional, defaults to the authenticated user if no other lookup identifier set.

TitleDisplayName
  • string

Title-specific username for the account to find (if no Email is set). Note that if the non-unique Title Display Names option is enabled for the title, attempts to look up users by Title Display Name will always return AccountNotFound.

Username
  • string

PlayFab Username for the account to find (if no PlayFabId is specified).

Responses

Name Type Description
200 OK

This API retrieves details regarding the player in the PlayFab service. Note that when this call is used to retrieve data about another player (not the one signed into the local client), some data, such as Personally Identifying Information (PII), will be omitted for privacy reasons or to comply with the requirements of the platform belongs to. The user account returned will be based on the identifier provided in priority order: PlayFabId, Username, Email, then TitleDisplayName. If no identifier is specified, the currently signed in user's information will be returned.

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

Currency
EntityKey

Combined entity type and ID structure which uniquely identifies a single entity.

GetAccountInfoRequest
GetAccountInfoResult

This API retrieves details regarding the player in the PlayFab service. Note that when this call is used to retrieve data about another player (not the one signed into the local client), some data, such as Personally Identifying Information (PII), will be omitted for privacy reasons or to comply with the requirements of the platform belongs to. The user account returned will be based on the identifier provided in priority order: PlayFabId, Username, Email, then TitleDisplayName. If no identifier is specified, the currently signed in user's information will be returned.

TitleActivationStatus
UserAccountInfo
UserAndroidDeviceInfo
UserCustomIdInfo
UserFacebookInfo
UserFacebookInstantGamesIdInfo
UserGameCenterInfo
UserGoogleInfo
UserIosDeviceInfo
UserKongregateInfo
UserNintendoSwitchDeviceIdInfo
UserOpenIdInfo
UserOrigination
UserPrivateAccountInfo
UserPsnInfo
UserSteamInfo
UserTitleInfo
UserTwitchInfo
UserWindowsHelloInfo
UserXboxInfo

ApiErrorWrapper

The basic wrapper around every failed API response

Name Type Description
code
  • number

Numerical HTTP code

error
  • string

Playfab error code

errorCode
  • number

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

Currency

Name Type Description
AED
  • string
AFN
  • string
ALL
  • string
AMD
  • string
ANG
  • string
AOA
  • string
ARS
  • string
AUD
  • string
AWG
  • string
AZN
  • string
BAM
  • string
BBD
  • string
BDT
  • string
BGN
  • string
BHD
  • string
BIF
  • string
BMD
  • string
BND
  • string
BOB
  • string
BRL
  • string
BSD
  • string
BTN
  • string
BWP
  • string
BYR
  • string
BZD
  • string
CAD
  • string
CDF
  • string
CHF
  • string
CLP
  • string
CNY
  • string
COP
  • string
CRC
  • string
CUC
  • string
CUP
  • string
CVE
  • string
CZK
  • string
DJF
  • string
DKK
  • string
DOP
  • string
DZD
  • string
EGP
  • string
ERN
  • string
ETB
  • string
EUR
  • string
FJD
  • string
FKP
  • string
GBP
  • string
GEL
  • string
GGP
  • string
GHS
  • string
GIP
  • string
GMD
  • string
GNF
  • string
GTQ
  • string
GYD
  • string
HKD
  • string
HNL
  • string
HRK
  • string
HTG
  • string
HUF
  • string
IDR
  • string
ILS
  • string
IMP
  • string
INR
  • string
IQD
  • string
IRR
  • string
ISK
  • string
JEP
  • string
JMD
  • string
JOD
  • string
JPY
  • string
KES
  • string
KGS
  • string
KHR
  • string
KMF
  • string
KPW
  • string
KRW
  • string
KWD
  • string
KYD
  • string
KZT
  • string
LAK
  • string
LBP
  • string
LKR
  • string
LRD
  • string
LSL
  • string
LYD
  • string
MAD
  • string
MDL
  • string
MGA
  • string
MKD
  • string
MMK
  • string
MNT
  • string
MOP
  • string
MRO
  • string
MUR
  • string
MVR
  • string
MWK
  • string
MXN
  • string
MYR
  • string
MZN
  • string
NAD
  • string
NGN
  • string
NIO
  • string
NOK
  • string
NPR
  • string
NZD
  • string
OMR
  • string
PAB
  • string
PEN
  • string
PGK
  • string
PHP
  • string
PKR
  • string
PLN
  • string
PYG
  • string
QAR
  • string
RON
  • string
RSD
  • string
RUB
  • string
RWF
  • string
SAR
  • string
SBD
  • string
SCR
  • string
SDG
  • string
SEK
  • string
SGD
  • string
SHP
  • string
SLL
  • string
SOS
  • string
SPL
  • string
SRD
  • string
STD
  • string
SVC
  • string
SYP
  • string
SZL
  • string
THB
  • string
TJS
  • string
TMT
  • string
TND
  • string
TOP
  • string
TRY
  • string
TTD
  • string
TVD
  • string
TWD
  • string
TZS
  • string
UAH
  • string
UGX
  • string
USD
  • string
UYU
  • string
UZS
  • string
VEF
  • string
VND
  • string
VUV
  • string
WST
  • string
XAF
  • string
XCD
  • string
XDR
  • string
XOF
  • string
XPF
  • string
YER
  • string
ZAR
  • string
ZMW
  • string
ZWD
  • string

EntityKey

Combined entity type and ID structure which uniquely identifies a single entity.

Name Type Description
Id
  • string

Unique ID of the entity.

Type
  • string

Entity type. See https://api.playfab.com/docs/tutorials/entities/entitytypes

TypeString
  • string

Alternate name for Type.

GetAccountInfoRequest

Name Type Description
Email
  • string

User email address for the account to find (if no Username is specified).

PlayFabId
  • string

Unique PlayFab identifier of the user whose info is being requested. Optional, defaults to the authenticated user if no other lookup identifier set.

TitleDisplayName
  • string

Title-specific username for the account to find (if no Email is set). Note that if the non-unique Title Display Names option is enabled for the title, attempts to look up users by Title Display Name will always return AccountNotFound.

Username
  • string

PlayFab Username for the account to find (if no PlayFabId is specified).

GetAccountInfoResult

This API retrieves details regarding the player in the PlayFab service. Note that when this call is used to retrieve data about another player (not the one signed into the local client), some data, such as Personally Identifying Information (PII), will be omitted for privacy reasons or to comply with the requirements of the platform belongs to. The user account returned will be based on the identifier provided in priority order: PlayFabId, Username, Email, then TitleDisplayName. If no identifier is specified, the currently signed in user's information will be returned.

Name Type Description
AccountInfo

Account information for the local user.

TitleActivationStatus

Name Type Description
ActivatedSteam
  • string
ActivatedTitleKey
  • string
None
  • string
PendingSteam
  • string
RevokedSteam
  • string

UserAccountInfo

Name Type Description
AndroidDeviceInfo

User Android device information, if an Android device has been linked

Created
  • string

Timestamp indicating when the user account was created

CustomIdInfo

Custom ID information, if a custom ID has been assigned

FacebookInfo

User Facebook information, if a Facebook account has been linked

FacebookInstantGamesIdInfo

Facebook Instant Games account information, if a Facebook Instant Games account has been linked

GameCenterInfo

User Gamecenter information, if a Gamecenter account has been linked

GoogleInfo

User Google account information, if a Google account has been linked

IosDeviceInfo

User iOS device information, if an iOS device has been linked

KongregateInfo

User Kongregate account information, if a Kongregate account has been linked

NintendoSwitchDeviceIdInfo

Nintendo Switch account information, if a Nintendo Switch account has been linked

OpenIdInfo

OpenID Connect information, if any OpenID Connect accounts have been linked

PlayFabId
  • string

Unique identifier for the user account

PrivateInfo

Personal information for the user which is considered more sensitive

PsnInfo

User PSN account information, if a PSN account has been linked

SteamInfo

User Steam information, if a Steam account has been linked

TitleInfo

Title-specific information for the user account

TwitchInfo

User Twitch account information, if a Twitch account has been linked

Username
  • string

User account name in the PlayFab service

WindowsHelloInfo

Windows Hello account information, if a Windows Hello account has been linked

XboxInfo

User XBox account information, if a XBox account has been linked

UserAndroidDeviceInfo

Name Type Description
AndroidDeviceId
  • string

Android device ID

UserCustomIdInfo

Name Type Description
CustomId
  • string

Custom ID

UserFacebookInfo

Name Type Description
FacebookId
  • string

Facebook identifier

FullName
  • string

Facebook full name

UserFacebookInstantGamesIdInfo

Name Type Description
FacebookInstantGamesId
  • string

Facebook Instant Games ID

UserGameCenterInfo

Name Type Description
GameCenterId
  • string

Gamecenter identifier

UserGoogleInfo

Name Type Description
GoogleEmail
  • string

Email address of the Google account

GoogleGender
  • string

Gender information of the Google account

GoogleId
  • string

Google ID

GoogleLocale
  • string

Locale of the Google account

GoogleName
  • string

Name of the Google account user

UserIosDeviceInfo

Name Type Description
IosDeviceId
  • string

iOS device ID

UserKongregateInfo

Name Type Description
KongregateId
  • string

Kongregate ID

KongregateName
  • string

Kongregate Username

UserNintendoSwitchDeviceIdInfo

Name Type Description
NintendoSwitchDeviceId
  • string

Nintendo Switch Device ID

UserOpenIdInfo

Name Type Description
ConnectionId
  • string

OpenID Connection ID

Issuer
  • string

OpenID Issuer

Subject
  • string

OpenID Subject

UserOrigination

Name Type Description
Amazon
  • string
Android
  • string
CustomId
  • string
Facebook
  • string
FacebookInstantGamesId
  • string
GameCenter
  • string
GamersFirst
  • string
Google
  • string
IOS
  • string
Kongregate
  • string
LoadTest
  • string
NintendoSwitchDeviceId
  • string
OpenIdConnect
  • string
Organic
  • string
PSN
  • string
Parse
  • string
ServerCustomId
  • string
Steam
  • string
Twitch
  • string
Unknown
  • string
WindowsHello
  • string
XboxLive
  • string

UserPrivateAccountInfo

Name Type Description
Email
  • string

user email address

UserPsnInfo

Name Type Description
PsnAccountId
  • string

PSN account ID

PsnOnlineId
  • string

PSN online ID

UserSteamInfo

Name Type Description
SteamActivationStatus

what stage of game ownership the user is listed as being in, from Steam

SteamCountry
  • string

the country in which the player resides, from Steam data

SteamCurrency

currency type set in the user Steam account

SteamId
  • string

Steam identifier

SteamName
  • string

Steam display name

UserTitleInfo

Name Type Description
AvatarUrl
  • string

URL to the player's avatar.

Created
  • string

timestamp indicating when the user was first associated with this game (this can differ significantly from when the user first registered with PlayFab)

DisplayName
  • string

name of the user, as it is displayed in-game

FirstLogin
  • string

timestamp indicating when the user first signed into this game (this can differ from the Created timestamp, as other events, such as issuing a beta key to the user, can associate the title to the user)

LastLogin
  • string

timestamp for the last user login for this title

Origination

source by which the user first joined the game, if known

TitlePlayerAccount

Title player account entity for this user

isBanned
  • boolean

boolean indicating whether or not the user is currently banned for a title

UserTwitchInfo

Name Type Description
TwitchId
  • string

Twitch ID

TwitchUserName
  • string

Twitch Username

UserWindowsHelloInfo

Name Type Description
WindowsHelloDeviceName
  • string

Windows Hello Device Name

WindowsHelloPublicKeyHash
  • string

Windows Hello Public Key Hash

UserXboxInfo

Name Type Description
XboxUserId
  • string

XBox user ID

Error Codes

Name Code
AccountNotFound 1001