> ## Documentation Index > Fetch the complete documentation index at: https://devdocs.xbox.com/llms.txt > Use this file to discover all available pages before exploring further. # 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. ## Error codes This operation may return the following PlayFab errors: | Error | Code | | --- | --- | | AccountNotFound | 1001 | | ExpiredXboxLiveToken | 1189 | | FacebookAPIError | 1143 | | InvalidSignature | 1273 | | InvalidSignatureTime | 1324 | | InvalidXboxLiveToken | 1188 | | PlayerSecretNotConfigured | 1323 | | XboxInaccessible | 1339 | | XboxServiceTooManyRequests | 1505 | | XboxXASSExchangeFailure | 1306 | ## OpenAPI ````yaml post /Server/GetFriendsList openapi: 3.0.0 info: version: '260922' title: PlayFab Server API description: >- Provides functionality to allow external (developer-controlled) servers to interact with user inventories and data in a trusted manner, and to handle matchmaking and client connection orchestration termsOfService: https://playfab.com/terms/ contact: url: https://community.playfab.com/index.html license: name: Apache 2.0 url: https://github.com/PlayFab/API_Specs/blob/master/LICENSE servers: - url: https://{titleId}.playfabapi.com description: PlayFab title endpoint variables: titleId: default: your_title_id description: Your PlayFab title ID (hex). security: [] tags: - name: Account Management description: Account Management APIs - name: Analytics description: Analytics APIs - name: Authentication description: Authentication APIs - name: Character Data description: Character Data APIs - name: Characters description: Characters APIs - name: Content description: Content Service APIs - name: Friend List Management description: Friend List Management APIs - name: Matchmaking description: Matchmaking APIs - name: Platform Specific Methods description: Platform Specific Methods APIs - name: Player Data Management description: Player Data Management APIs - name: Player Item Management description: Player Item Management APIs - name: PlayStream description: PlayStream Management APIs - name: Server-Side Cloud Script description: Server-Side Cloud Script APIs - name: Shared Group Data description: Shared Group Data APIs - name: Title-Wide Data Management description: Title-Wide Data Management APIs paths: /Server/GetFriendsList: post: tags: - Friend List Management summary: Get Friends List description: > 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. ## Error codes This operation may return the following PlayFab errors: | Error | Code | | --- | --- | | AccountNotFound | 1001 | | ExpiredXboxLiveToken | 1189 | | FacebookAPIError | 1143 | | InvalidSignature | 1273 | | InvalidSignatureTime | 1324 | | InvalidXboxLiveToken | 1188 | | PlayerSecretNotConfigured | 1323 | | XboxInaccessible | 1339 | | XboxServiceTooManyRequests | 1505 | | XboxXASSExchangeFailure | 1306 | operationId: GetFriendsList requestBody: content: application/json: schema: $ref: '#/components/schemas/GetFriendsListRequest' responses: '200': $ref: '#/components/responses/GetFriendsListResult' '400': $ref: '#/components/responses/ApiErrorWrapper' security: - SecretKey: [] components: schemas: GetFriendsListRequest: type: object properties: CustomTags: description: >- The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). type: object ExternalPlatformFriends: allOf: - $ref: '#/components/schemas/ExternalFriendSources' description: >- Indicates which other platforms' friends should be included in the response. In HTTP, it is represented as a comma-separated list of platforms. NamespaceWide: description: >- If true, include friends from the same namespace even if they have not logged in to the current title. Defaults to false. type: boolean PlayFabId: description: PlayFab identifier of the player whose friend list to get. type: string ProfileConstraints: allOf: - $ref: '#/components/schemas/PlayerProfileViewConstraints' description: >- 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: description: >- Xbox token if Xbox friends should be included. Requires Xbox be configured on PlayFab. When provided, all Xbox Live users the caller is following are included regardless of whether they follow the caller back. type: string required: - PlayFabId example: PlayFabId: '93798903892789754' ExternalPlatformFriends: All ExternalFriendSources: type: string enum: - None - Steam - Facebook - Xbox - Psn - All PlayerProfileViewConstraints: type: object properties: ShowAvatarUrl: description: Whether to show player's avatar URL. Defaults to false type: boolean ShowBannedUntil: description: Whether to show the banned until time. Defaults to false type: boolean ShowCampaignAttributions: description: Whether to show campaign attributions. Defaults to false type: boolean ShowContactEmailAddresses: description: Whether to show contact email addresses. Defaults to false type: boolean ShowCreated: description: Whether to show the created date. Defaults to false type: boolean ShowDisplayName: description: Whether to show the display name. Defaults to false type: boolean ShowExperimentVariants: description: Whether to show player's experiment variants. Defaults to false type: boolean ShowLastLogin: description: Whether to show the last login time. Defaults to false type: boolean ShowLinkedAccounts: description: Whether to show the linked accounts. Defaults to false type: boolean ShowLocations: description: Whether to show player's locations. Defaults to false type: boolean ShowMemberships: description: Whether to show player's membership information. Defaults to false type: boolean ShowOrigination: description: Whether to show origination. Defaults to false type: boolean ShowPushNotificationRegistrations: description: Whether to show push notification registrations. Defaults to false type: boolean ShowStatistics: description: Reserved for future development type: boolean ShowTags: description: Whether to show tags. Defaults to false type: boolean ShowTotalValueToDateInUsd: description: Whether to show the total value to date in usd. Defaults to false type: boolean ShowValuesToDate: description: Whether to show the values to date. Defaults to false type: boolean required: - ShowDisplayName - ShowCreated - ShowOrigination - ShowLastLogin - ShowBannedUntil - ShowStatistics - ShowCampaignAttributions - ShowPushNotificationRegistrations - ShowLinkedAccounts - ShowContactEmailAddresses - ShowTotalValueToDateInUsd - ShowValuesToDate - ShowTags - ShowLocations - ShowAvatarUrl - ShowMemberships - ShowExperimentVariants GetFriendsListResult: description: >- 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. Xbox Live friends include all users the caller is following, regardless of whether those users follow the caller back. This differs from FindFriendLobbies, which only considers mutual Xbox Live friends. type: object properties: Friends: description: Array of friends found. type: array items: $ref: '#/components/schemas/FriendInfo' x-isclass: true example: Friends: - FriendPlayFabId: '93798903892789754' Username: accountName TitleDisplayName: Davros01 Tags: - single blue eye - genius with robotics CurrentMatchmakerLobbyId: '2073' Profile: AvatarUrl: https://example.org/profile1.jpg Statistics: - Name: Points Version: 2 Value: 7 - Name: Points Version: 1 Value: 40 - Name: XP Version: 1 Value: 10 - FriendPlayFabId: 334907923945f Username: accountName TitleDisplayName: CyberLeader1 Tags: - allergic to gold - upgradeable CurrentMatchmakerLobbyId: '2073' Profile: AvatarUrl: https://example.org/profile2.jpg Statistics: - Name: Points Version: 2 Value: 15 - Name: XP Version: 1 Value: 10 ApiErrorWrapper: description: The basic wrapper around every failed API response type: object properties: code: description: Numerical HTTP code type: integer status: description: String HTTP code type: string error: description: Playfab error code type: string errorCode: description: Numerical PlayFab error code type: integer errorMessage: description: Description for the PlayFab errorCode type: string errorDetails: description: Detailed description of individual issues with the request object type: object required: - code - errorCode FriendInfo: type: object properties: FacebookInfo: allOf: - $ref: '#/components/schemas/UserFacebookInfo' description: >- Available Facebook information (if the user and connected Facebook friend both have PlayFab Accounts in the same title). FriendPlayFabId: description: PlayFab unique identifier for this friend. type: string GameCenterInfo: allOf: - $ref: '#/components/schemas/UserGameCenterInfo' description: >- Available Game Center information (if the user and connected Game Center friend both have PlayFab Accounts in the same title). Profile: allOf: - $ref: '#/components/schemas/PlayerProfileModel' description: The profile of the user, if requested. PSNInfo: allOf: - $ref: '#/components/schemas/UserPsnInfo' description: >- Available PlayStation™ Network information, if the user connected PlayStation :tm Network friend both have PlayFab Accounts in the same title. SteamInfo: allOf: - $ref: '#/components/schemas/UserSteamInfo' description: >- Available Steam information (if the user and connected Steam friend both have PlayFab Accounts in the same title). Tags: description: Tags which have been associated with this friend. type: array items: type: string TitleDisplayName: description: Title-specific display name for this friend. type: string Username: description: PlayFab unique username for this friend. type: string XboxInfo: allOf: - $ref: '#/components/schemas/UserXboxInfo' description: >- Available Xbox information, (if the user and connected Xbox Live friend both have PlayFab Accounts in the same title). example: FriendPlayFabId: 93798903892789754w Username: accountName TitleDisplayName: Davros01 Tags: - single blue eye - genius with robotics CurrentMatchmakerLobbyId: '2073' Profile: AvatarUrl: https://example.org/profile.jpg Statistics: - Name: Points Version: 2 Value: 15 - Name: XP Version: 1 Value: 10 UserFacebookInfo: type: object properties: FacebookId: description: Facebook identifier type: string FullName: description: Facebook full name type: string UserGameCenterInfo: type: object properties: GameCenterId: description: Gamecenter identifier type: string PlayerProfileModel: type: object properties: AdCampaignAttributions: description: List of advertising campaigns the player has been attributed to type: array items: $ref: '#/components/schemas/AdCampaignAttributionModel' x-isclass: true AvatarUrl: description: URL of the player's avatar image type: string BannedUntil: description: If the player is currently banned, the UTC Date when the ban expires type: string ContactEmailAddresses: description: List of all contact email info associated with the player account type: array items: $ref: '#/components/schemas/ContactEmailInfoModel' x-isclass: true Created: description: Player record created type: string DisplayName: description: Player display name type: string ExperimentVariants: description: >- 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. type: array items: type: string LastLogin: description: UTC time when the player most recently logged in to the title type: string LinkedAccounts: description: List of all authentication systems linked to this player account type: array items: $ref: '#/components/schemas/LinkedPlatformAccountModel' x-isclass: true Locations: description: >- List of geographic locations from which the player has logged in to the title type: array items: $ref: '#/components/schemas/LocationModel' x-isclass: true Memberships: description: List of memberships for the player, along with whether are expired. type: array items: $ref: '#/components/schemas/MembershipModel' x-isclass: true Origination: allOf: - $ref: '#/components/schemas/LoginIdentityProvider' description: Player account origination PlayerId: description: PlayFab player account unique identifier type: string PublisherId: description: Publisher this player belongs to type: string PushNotificationRegistrations: description: >- List of configured end points registered for sending the player push notifications type: array items: $ref: '#/components/schemas/PushNotificationRegistrationModel' x-isclass: true Statistics: description: List of leaderboard statistic values for the player type: array items: $ref: '#/components/schemas/StatisticModel' x-isclass: true Tags: description: List of player's tags for segmentation type: array items: $ref: '#/components/schemas/TagModel' x-isclass: true TitleId: description: Title ID this player profile applies to type: string TotalValueToDateInUSD: description: >- 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. type: number x-actualtype: uint32 ValuesToDate: description: >- List of the player's lifetime purchase totals, summed by real-money currency type: array items: $ref: '#/components/schemas/ValueToDateModel' x-isclass: true example: TitleId: FFFF PlayerId: 1234ABCD Created: '2019-02-11T20:23:05' LastLogin: '2020-02-11T20:23:05' DisplayName: Gudge UserPsnInfo: type: object properties: IssuerId: description: >- Id of the PlayStation™ Network issuer environment this account is keyed under. Supply this value as IssuerId when looking the account up. type: number x-actualtype: int32 PsnAccountId: description: PlayStation™ Network account ID type: string PsnOnlineId: description: PlayStation™ Network online ID type: string PsnSandboxId: description: PlayStation™ Network sandbox ID type: string UserSteamInfo: type: object properties: SteamActivationStatus: allOf: - $ref: '#/components/schemas/TitleActivationStatus' description: >- what stage of game ownership the user is listed as being in, from Steam SteamCountry: description: the country in which the player resides, from Steam data type: string SteamCurrency: allOf: - $ref: '#/components/schemas/Currency' description: currency type set in the user Steam account SteamId: description: Steam identifier type: string SteamName: description: Steam display name type: string UserXboxInfo: type: object properties: XboxUserId: description: XBox user ID type: string XboxUserSandbox: description: XBox user sandbox type: string AdCampaignAttributionModel: type: object properties: AttributedAt: description: UTC time stamp of attribution type: string CampaignId: description: Attribution campaign identifier type: string Platform: description: Attribution network name type: string required: - AttributedAt ContactEmailInfoModel: type: object properties: EmailAddress: description: The email address type: string Name: description: The name of the email info data type: string VerificationStatus: allOf: - $ref: '#/components/schemas/EmailVerificationStatus' description: The verification status of the email LinkedPlatformAccountModel: type: object properties: Email: description: Linked account email of the user on the platform, if available type: string Platform: allOf: - $ref: '#/components/schemas/LoginIdentityProvider' description: Authentication platform PlatformUserId: description: Unique account identifier of the user on the platform type: string Username: description: Linked account username of the user on the platform, if available type: string LocationModel: type: object properties: City: description: City name. type: string ContinentCode: allOf: - $ref: '#/components/schemas/ContinentCode' description: The two-character continent code for this location CountryCode: allOf: - $ref: '#/components/schemas/CountryCode' description: >- The two-character ISO 3166-1 country code for the country associated with the location Latitude: description: Latitude coordinate of the geographic location. type: number x-actualtype: double Longitude: description: Longitude coordinate of the geographic location. type: number x-actualtype: double MembershipModel: type: object properties: IsActive: description: >- Whether this membership is active. That is, whether the MembershipExpiration time has been reached. type: boolean MembershipExpiration: description: The time this membership expires type: string MembershipId: description: The id of the membership type: string OverrideExpiration: description: >- 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. type: string OverrideIsSet: description: Whether the override expiration is set. type: boolean x-GovernsProperty: OverrideExpiration Subscriptions: description: The list of subscriptions that this player has for this membership type: array items: $ref: '#/components/schemas/SubscriptionModel' x-isclass: true required: - MembershipExpiration - IsActive LoginIdentityProvider: type: string enum: - 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 PushNotificationRegistrationModel: type: object properties: NotificationEndpointARN: description: Notification configured endpoint type: string Platform: allOf: - $ref: '#/components/schemas/PushNotificationPlatform' description: Push notification platform StatisticModel: type: object properties: Name: description: Statistic name type: string Value: description: Statistic value type: number x-actualtype: int32 Version: description: Statistic version (0 if not a versioned statistic) type: number x-actualtype: int32 required: - Version - Value TagModel: type: object properties: TagValue: description: Full value of the tag, including namespace type: string ValueToDateModel: type: object properties: Currency: description: ISO 4217 code of the currency used in the purchases type: string TotalValue: description: >- 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') type: number x-actualtype: uint32 TotalValueAsDecimal: description: >- 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'. type: string required: - TotalValue TitleActivationStatus: type: string enum: - None - ActivatedTitleKey - PendingSteam - ActivatedSteam - RevokedSteam Currency: type: string enum: - 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: type: string enum: - Unverified - Pending - Confirmed ContinentCode: type: string enum: - AF - AN - AS - EU - NA - OC - SA - Unknown CountryCode: type: string enum: - 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 SubscriptionModel: type: object properties: Expiration: description: When this subscription expires. type: string InitialSubscriptionTime: description: The time the subscription was orignially purchased type: string IsActive: description: >- Whether this subscription is currently active. That is, if Expiration > now. type: boolean Status: allOf: - $ref: '#/components/schemas/SubscriptionProviderStatus' description: >- The status of this subscription, according to the subscription provider. SubscriptionId: description: The id for this subscription type: string SubscriptionItemId: description: The item id for this subscription from the primary catalog type: string SubscriptionProvider: description: >- The provider for this subscription. Apple or Google Play are supported today. type: string required: - Expiration - IsActive - InitialSubscriptionTime PushNotificationPlatform: type: string enum: - ApplePushNotificationService - GoogleCloudMessaging SubscriptionProviderStatus: type: string enum: - NoError - Cancelled - UnknownError - BillingError - ProductUnavailable - CustomerDidNotAcceptPriceChange - FreeTrial - PaymentPending responses: GetFriendsListResult: description: >- 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. Xbox Live friends include all users the caller is following, regardless of whether those users follow the caller back. This differs from FindFriendLobbies, which only considers mutual Xbox Live friends. content: application/json: schema: type: object properties: code: type: integer description: >- The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code. status: type: string description: The Http status code as a string. data: $ref: '#/components/schemas/GetFriendsListResult' example: code: 200 status: OK data: Friends: - FriendPlayFabId: '93798903892789754' Username: accountName TitleDisplayName: Davros01 Tags: - single blue eye - genius with robotics CurrentMatchmakerLobbyId: '2073' Profile: AvatarUrl: https://example.org/profile1.jpg Statistics: - Name: Points Version: 2 Value: 7 - Name: Points Version: 1 Value: 40 - Name: XP Version: 1 Value: 10 - FriendPlayFabId: 334907923945f Username: accountName TitleDisplayName: CyberLeader1 Tags: - allergic to gold - upgradeable CurrentMatchmakerLobbyId: '2073' Profile: AvatarUrl: https://example.org/profile2.jpg Statistics: - Name: Points Version: 2 Value: 15 - Name: XP Version: 1 Value: 10 ApiErrorWrapper: description: This is the outer wrapper for all responses with errors content: application/json: schema: $ref: '#/components/schemas/ApiErrorWrapper' securitySchemes: SecretKey: type: apiKey in: header name: X-SecretKey description: >- This API requires a title secret key, available to title admins, from PlayFab Game Manager. ```` ## Related topics - [Get Friends List](/services/playfab/api-references/rest/client/friend-list-management/get-friends-list.md) - [Friends lists](/services/playfab/community/associations/friends/quickstart.md) - [PFFriendsGetFriendsListResult](/services/playfab/api-references/c/pffriendstypes/structs/pffriendsgetfriendslistresult.md) - [PFFriendsClientGetFriendsListAsync](/services/playfab/api-references/c/pffriends/functions/pffriendsclientgetfriendslistasync.md) - [PFFriendsServerGetFriendsListAsync](/services/playfab/api-references/c/pffriends/functions/pffriendsservergetfriendslistasync.md)