Share via


Friend List Management - Get Friends List

Retrieves the current friends for the user with PlayFabId, constrained to users who have PlayFab accounts. Friends from linked accounts (Facebook, Steam) are also included. You may optionally exclude some linked services' friends.

POST https://titleId.playfabapi.com/Server/GetFriendsList

Request Header

Name Required Type Description
X-SecretKey True

string

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

Request Body

Name Required Type Description
PlayFabId True

string

PlayFab identifier of the player whose friend list to get.

CustomTags

object

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

ExternalPlatformFriends

ExternalFriendSources

Indicates which other platforms' friends should be included in the response. In HTTP, it is represented as a comma-separated list of platforms.

ProfileConstraints

PlayerProfileViewConstraints

If non-null, this determines which properties of the resulting player profiles to return. For API calls from the client, only the allowed client profile properties for the title may be requested. These allowed properties are configured in the Game Manager "Client Profile Options" tab in the "Settings" section.

XboxToken

string

Xbox token if Xbox friends should be included. Requires Xbox be configured on PlayFab.

Responses

Name Type Description
200 OK

GetFriendsListResult

If any additional services are queried for the user's friends, those friends who also have a PlayFab account registered for the title will be returned in the results. For Facebook, user has to have logged into the title's Facebook app recently, and only friends who also plays this game will be included. For Xbox Live, user has to have logged into the Xbox Live recently, and only friends who also play this game will be included.

400 Bad Request

ApiErrorWrapper

This is the outer wrapper for all responses with errors

Security

X-SecretKey

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

Type: apiKey
In: header

Definitions

Name Description
AdCampaignAttributionModel
ApiErrorWrapper

The basic wrapper around every failed API response

ContactEmailInfoModel
ContinentCode
CountryCode
Currency
EmailVerificationStatus
ExternalFriendSources
FriendInfo
GetFriendsListRequest
GetFriendsListResult

If any additional services are queried for the user's friends, those friends who also have a PlayFab account registered for the title will be returned in the results. For Facebook, user has to have logged into the title's Facebook app recently, and only friends who also plays this game will be included. For Xbox Live, user has to have logged into the Xbox Live recently, and only friends who also play this game will be included.

LinkedPlatformAccountModel
LocationModel
LoginIdentityProvider
MembershipModel
PlayerProfileModel
PlayerProfileViewConstraints
PushNotificationPlatform
PushNotificationRegistrationModel
StatisticModel
SubscriptionModel
SubscriptionProviderStatus
TagModel
TitleActivationStatus
UserFacebookInfo
UserGameCenterInfo
UserPsnInfo
UserSteamInfo
UserXboxInfo
ValueToDateModel

AdCampaignAttributionModel

Name Type Description
AttributedAt

string

UTC time stamp of attribution

CampaignId

string

Attribution campaign identifier

Platform

string

Attribution network name

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

ContactEmailInfoModel

Name Type Description
EmailAddress

string

The email address

Name

string

The name of the email info data

VerificationStatus

EmailVerificationStatus

The verification status of the email

ContinentCode

Value Description
AF
AN
AS
EU
NA
OC
SA
Unknown

CountryCode

Value Description
AF
AX
AL
DZ
AS
AD
AO
AI
AQ
AG
AR
AM
AW
AU
AT
AZ
BS
BH
BD
BB
BY
BE
BZ
BJ
BM
BT
BO
BQ
BA
BW
BV
BR
IO
BN
BG
BF
BI
KH
CM
CA
CV
KY
CF
TD
CL
CN
CX
CC
CO
KM
CG
CD
CK
CR
CI
HR
CU
CW
CY
CZ
DK
DJ
DM
DO
EC
EG
SV
GQ
ER
EE
ET
FK
FO
FJ
FI
FR
GF
PF
TF
GA
GM
GE
DE
GH
GI
GR
GL
GD
GP
GU
GT
GG
GN
GW
GY
HT
HM
VA
HN
HK
HU
IS
IN
ID
IR
IQ
IE
IM
IL
IT
JM
JP
JE
JO
KZ
KE
KI
KP
KR
KW
KG
LA
LV
LB
LS
LR
LY
LI
LT
LU
MO
MK
MG
MW
MY
MV
ML
MT
MH
MQ
MR
MU
YT
MX
FM
MD
MC
MN
ME
MS
MA
MZ
MM
NA
NR
NP
NL
NC
NZ
NI
NE
NG
NU
NF
MP
NO
OM
PK
PW
PS
PA
PG
PY
PE
PH
PN
PL
PT
PR
QA
RE
RO
RU
RW
BL
SH
KN
LC
MF
PM
VC
WS
SM
ST
SA
SN
RS
SC
SL
SG
SX
SK
SI
SB
SO
ZA
GS
SS
ES
LK
SD
SR
SJ
SZ
SE
CH
SY
TW
TJ
TZ
TH
TL
TG
TK
TO
TT
TN
TR
TM
TC
TV
UG
UA
AE
GB
US
UM
UY
UZ
VU
VE
VN
VG
VI
WF
EH
YE
ZM
ZW
Unknown

Currency

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

EmailVerificationStatus

Value Description
Unverified
Pending
Confirmed

ExternalFriendSources

Value Description
None
Steam
Facebook
Xbox
Psn
All

FriendInfo

Name Type Description
FacebookInfo

UserFacebookInfo

Available Facebook information (if the user and connected Facebook friend both have PlayFab Accounts in the same title).

FriendPlayFabId

string

PlayFab unique identifier for this friend.

GameCenterInfo

UserGameCenterInfo

Available Game Center information (if the user and connected Game Center friend both have PlayFab Accounts in the same title).

PSNInfo

UserPsnInfo

Available PlayStation ™️ Network information, if the user connected PlayStation :tm Network friend both have PlayFab Accounts in the same title.

Profile

PlayerProfileModel

The profile of the user, if requested.

SteamInfo

UserSteamInfo

Available Steam information (if the user and connected Steam friend both have PlayFab Accounts in the same title).

Tags

string[]

Tags which have been associated with this friend.

TitleDisplayName

string

Title-specific display name for this friend.

Username

string

PlayFab unique username for this friend.

XboxInfo

UserXboxInfo

Available Xbox information, (if the user and connected Xbox Live friend both have PlayFab Accounts in the same title).

GetFriendsListRequest

Name Type Description
CustomTags

object

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

ExternalPlatformFriends

ExternalFriendSources

Indicates which other platforms' friends should be included in the response. In HTTP, it is represented as a comma-separated list of platforms.

PlayFabId

string

PlayFab identifier of the player whose friend list to get.

ProfileConstraints

PlayerProfileViewConstraints

If non-null, this determines which properties of the resulting player profiles to return. For API calls from the client, only the allowed client profile properties for the title may be requested. These allowed properties are configured in the Game Manager "Client Profile Options" tab in the "Settings" section.

XboxToken

string

Xbox token if Xbox friends should be included. Requires Xbox be configured on PlayFab.

GetFriendsListResult

If any additional services are queried for the user's friends, those friends who also have a PlayFab account registered for the title will be returned in the results. For Facebook, user has to have logged into the title's Facebook app recently, and only friends who also plays this game will be included. For Xbox Live, user has to have logged into the Xbox Live recently, and only friends who also play this game will be included.

Name Type Description
Friends

FriendInfo[]

Array of friends found.

LinkedPlatformAccountModel

Name Type Description
Email

string

Linked account email of the user on the platform, if available

Platform

LoginIdentityProvider

Authentication platform

PlatformUserId

string

Unique account identifier of the user on the platform

Username

string

Linked account username of the user on the platform, if available

LocationModel

Name Type Description
City

string

City name.

ContinentCode

ContinentCode

The two-character continent code for this location

CountryCode

CountryCode

The two-character ISO 3166-1 country code for the country associated with the location

Latitude

number

Latitude coordinate of the geographic location.

Longitude

number

Longitude coordinate of the geographic location.

LoginIdentityProvider

Value Description
Unknown
PlayFab
Custom
GameCenter
GooglePlay
Steam
XBoxLive
PSN
Kongregate
Facebook
IOSDevice
AndroidDevice
Twitch
WindowsHello
GameServer
CustomServer
NintendoSwitch
FacebookInstantGames
OpenIdConnect
Apple
NintendoSwitchAccount
GooglePlayGames
XboxMobileStore
King
BattleNet

MembershipModel

Name Type Description
IsActive

boolean

Whether this membership is active. That is, whether the MembershipExpiration time has been reached.

MembershipExpiration

string

The time this membership expires

MembershipId

string

The id of the membership

OverrideExpiration

string

Membership expirations can be explicitly overridden (via game manager or the admin api). If this membership has been overridden, this will be the new expiration time.

OverrideIsSet

boolean

Whether the override expiration is set.

Subscriptions

SubscriptionModel[]

The list of subscriptions that this player has for this membership

PlayerProfileModel

Name Type Description
AdCampaignAttributions

AdCampaignAttributionModel[]

List of advertising campaigns the player has been attributed to

AvatarUrl

string

URL of the player's avatar image

BannedUntil

string

If the player is currently banned, the UTC Date when the ban expires

ContactEmailAddresses

ContactEmailInfoModel[]

List of all contact email info associated with the player account

Created

string

Player record created

DisplayName

string

Player display name

ExperimentVariants

string[]

List of experiment variants for the player. Note that these variants are not guaranteed to be up-to-date when returned during login because the player profile is updated only after login. Instead, use the LoginResult.TreatmentAssignment property during login to get the correct variants and variables.

LastLogin

string

UTC time when the player most recently logged in to the title

LinkedAccounts

LinkedPlatformAccountModel[]

List of all authentication systems linked to this player account

Locations

LocationModel[]

List of geographic locations from which the player has logged in to the title

Memberships

MembershipModel[]

List of memberships for the player, along with whether are expired.

Origination

LoginIdentityProvider

Player account origination

PlayerId

string

PlayFab player account unique identifier

PublisherId

string

Publisher this player belongs to

PushNotificationRegistrations

PushNotificationRegistrationModel[]

List of configured end points registered for sending the player push notifications

Statistics

StatisticModel[]

List of leaderboard statistic values for the player

Tags

TagModel[]

List of player's tags for segmentation

TitleId

string

Title ID this player profile applies to

TotalValueToDateInUSD

number

Sum of the player's purchases made with real-money currencies, converted to US dollars equivalent and represented as a whole number of cents (1/100 USD). For example, 999 indicates nine dollars and ninety-nine cents.

ValuesToDate

ValueToDateModel[]

List of the player's lifetime purchase totals, summed by real-money currency

PlayerProfileViewConstraints

Name Type Description
ShowAvatarUrl

boolean

Whether to show player's avatar URL. Defaults to false

ShowBannedUntil

boolean

Whether to show the banned until time. Defaults to false

ShowCampaignAttributions

boolean

Whether to show campaign attributions. Defaults to false

ShowContactEmailAddresses

boolean

Whether to show contact email addresses. Defaults to false

ShowCreated

boolean

Whether to show the created date. Defaults to false

ShowDisplayName

boolean

Whether to show the display name. Defaults to false

ShowExperimentVariants

boolean

Whether to show player's experiment variants. Defaults to false

ShowLastLogin

boolean

Whether to show the last login time. Defaults to false

ShowLinkedAccounts

boolean

Whether to show the linked accounts. Defaults to false

ShowLocations

boolean

Whether to show player's locations. Defaults to false

ShowMemberships

boolean

Whether to show player's membership information. Defaults to false

ShowOrigination

boolean

Whether to show origination. Defaults to false

ShowPushNotificationRegistrations

boolean

Whether to show push notification registrations. Defaults to false

ShowStatistics

boolean

Reserved for future development

ShowTags

boolean

Whether to show tags. Defaults to false

ShowTotalValueToDateInUsd

boolean

Whether to show the total value to date in usd. Defaults to false

ShowValuesToDate

boolean

Whether to show the values to date. Defaults to false

PushNotificationPlatform

Value Description
ApplePushNotificationService
GoogleCloudMessaging

PushNotificationRegistrationModel

Name Type Description
NotificationEndpointARN

string

Notification configured endpoint

Platform

PushNotificationPlatform

Push notification platform

StatisticModel

Name Type Description
Name

string

Statistic name

Value

number

Statistic value

Version

number

Statistic version (0 if not a versioned statistic)

SubscriptionModel

Name Type Description
Expiration

string

When this subscription expires.

InitialSubscriptionTime

string

The time the subscription was orignially purchased

IsActive

boolean

Whether this subscription is currently active. That is, if Expiration > now.

Status

SubscriptionProviderStatus

The status of this subscription, according to the subscription provider.

SubscriptionId

string

The id for this subscription

SubscriptionItemId

string

The item id for this subscription from the primary catalog

SubscriptionProvider

string

The provider for this subscription. Apple or Google Play are supported today.

SubscriptionProviderStatus

Value Description
NoError
Cancelled
UnknownError
BillingError
ProductUnavailable
CustomerDidNotAcceptPriceChange
FreeTrial
PaymentPending

TagModel

Name Type Description
TagValue

string

Full value of the tag, including namespace

TitleActivationStatus

Value Description
None
ActivatedTitleKey
PendingSteam
ActivatedSteam
RevokedSteam

UserFacebookInfo

Name Type Description
FacebookId

string

Facebook identifier

FullName

string

Facebook full name

UserGameCenterInfo

Name Type Description
GameCenterId

string

Gamecenter identifier

UserPsnInfo

Name Type Description
PsnAccountId

string

PlayStation ™️ Network account ID

PsnOnlineId

string

PlayStation ™️ Network online ID

UserSteamInfo

Name Type Description
SteamActivationStatus

TitleActivationStatus

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

currency type set in the user Steam account

SteamId

string

Steam identifier

SteamName

string

Steam display name

UserXboxInfo

Name Type Description
XboxUserId

string

XBox user ID

XboxUserSandbox

string

XBox user sandbox

ValueToDateModel

Name Type Description
Currency

string

ISO 4217 code of the currency used in the purchases

TotalValue

number

Total value of the purchases in a whole number of 1/100 monetary units. For example, 999 indicates nine dollars and ninety-nine cents when Currency is 'USD')

TotalValueAsDecimal

string

Total value of the purchases in a string representation of decimal monetary units. For example, '9.99' indicates nine dollars and ninety-nine cents when Currency is 'USD'.

Error Codes

Name Code
AccountNotFound 1001
ExpiredXboxLiveToken 1189
FacebookAPIError 1143
InvalidSignature 1273
InvalidSignatureTime 1324
InvalidXboxLiveToken 1188
PlayerSecretNotConfigured 1323
XboxInaccessible 1339
XboxServiceTooManyRequests 1505
XboxXASSExchangeFailure 1306