PlayFab

PlayFab Client API

APIs which provide the full range of PlayFab features available to the client - authentication, account and data management, inventory, friends, matchmaking,…

Media & content#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

APIs which provide the full range of PlayFab features available to the client - authentication, account and data management, inventory, friends, matchmaking, reporting, and platform-specific functionality

Endpoints 174

Account Management

  • POSTAddGenericID/Client/AddGenericIDAdds the specified generic service identifier to the player's PlayFab account. This is designed to allow for a PlayFab ID lookup of any arbitrary service…
  • POSTAddOrUpdateContactEmail/Client/AddOrUpdateContactEmailAdds or updates a contact email to the player's profile.
  • POSTAddUsernamePassword/Client/AddUsernamePasswordAdds playfab username/password auth to an existing account created via an anonymous auth method, e.g. automatic device ID login.
  • POSTGetAccountInfo/Client/GetAccountInfoRetrieves the user's PlayFab account details
  • POSTGetPlayerCombinedInfo/Client/GetPlayerCombinedInfoRetrieves all of the user's different kinds of info.
  • POSTGetPlayerProfile/Client/GetPlayerProfileRetrieves the player's profile
  • POSTGetPlayFabIDsFromBattleNetAccountIds/Client/GetPlayFabIDsFromBattleNetAccountIdsRetrieves the unique PlayFab identifiers for the given set of Battle.net account identifiers.
  • POSTGetPlayFabIDsFromFacebookIDs/Client/GetPlayFabIDsFromFacebookIDsRetrieves the unique PlayFab identifiers for the given set of Facebook identifiers.
  • POSTGetPlayFabIDsFromFacebookInstantGamesIds/Client/GetPlayFabIDsFromFacebookInstantGamesIdsRetrieves the unique PlayFab identifiers for the given set of Facebook Instant Game identifiers.
  • POSTGetPlayFabIDsFromGameCenterIDs/Client/GetPlayFabIDsFromGameCenterIDsRetrieves the unique PlayFab identifiers for the given set of Game Center identifiers (referenced in the Game Center Programming Guide as the Player…
  • POSTGetPlayFabIDsFromGenericIDs/Client/GetPlayFabIDsFromGenericIDsRetrieves the unique PlayFab identifiers for the given set of generic service identifiers. A generic identifier is the service name plus the service-specific…
  • POSTGetPlayFabIDsFromGoogleIDs/Client/GetPlayFabIDsFromGoogleIDsRetrieves the unique PlayFab identifiers for the given set of Google identifiers. The Google identifiers are the IDs for the user accounts, available as "id"…
  • POSTGetPlayFabIDsFromGooglePlayGamesPlayerIDs/Client/GetPlayFabIDsFromGooglePlayGamesPlayerIDsRetrieves the unique PlayFab identifiers for the given set of Google Play Games identifiers. The Google Play Games identifiers are the IDs for the user…
  • POSTGetPlayFabIDsFromKongregateIDs/Client/GetPlayFabIDsFromKongregateIDsRetrieves the unique PlayFab identifiers for the given set of Kongregate identifiers. The Kongregate identifiers are the IDs for the user accounts, available…
  • POSTGetPlayFabIDsFromNintendoServiceAccountIds/Client/GetPlayFabIDsFromNintendoServiceAccountIdsRetrieves the unique PlayFab identifiers for the given set of Nintendo Service Account identifiers.
  • POSTGetPlayFabIDsFromNintendoSwitchDeviceIds/Client/GetPlayFabIDsFromNintendoSwitchDeviceIdsRetrieves the unique PlayFab identifiers for the given set of Nintendo Switch Device identifiers.
  • POSTGetPlayFabIDsFromOpenIdSubjectIdentifiers/Client/GetPlayFabIDsFromOpenIdSubjectIdentifiersRetrieves the unique PlayFab identifiers for the given set of OpenId subject identifiers. A OpenId identifier is the service name plus the service-specific ID…
  • POSTGetPlayFabIDsFromPSNAccountIDs/Client/GetPlayFabIDsFromPSNAccountIDsRetrieves the unique PlayFab identifiers for the given set of PlayStation :tm: Network identifiers.
  • POSTGetPlayFabIDsFromPSNOnlineIDs/Client/GetPlayFabIDsFromPSNOnlineIDsRetrieves the unique PlayFab identifiers for the given set of PlayStation :tm: Network identifiers.
  • POSTGetPlayFabIDsFromSteamIDs/Client/GetPlayFabIDsFromSteamIDsRetrieves the unique PlayFab identifiers for the given set of Steam identifiers. The Steam identifiers are the profile IDs for the user accounts, available as…
  • POSTGetPlayFabIDsFromSteamNames/Client/GetPlayFabIDsFromSteamNamesRetrieves the unique PlayFab identifiers for the given set of Steam identifiers. The Steam identifiers are persona names.
  • POSTGetPlayFabIDsFromTwitchIDs/Client/GetPlayFabIDsFromTwitchIDsRetrieves the unique PlayFab identifiers for the given set of Twitch identifiers. The Twitch identifiers are the IDs for the user accounts, available as "_id"…
  • POSTGetPlayFabIDsFromXboxLiveIDs/Client/GetPlayFabIDsFromXboxLiveIDsRetrieves the unique PlayFab identifiers for the given set of XboxLive identifiers.
  • POSTLinkAndroidDeviceID/Client/LinkAndroidDeviceIDLinks the Android device identifier to the user's PlayFab account
  • POSTLinkApple/Client/LinkAppleLinks the Apple account associated with the token to the user's PlayFab account.
  • POSTLinkBattleNetAccount/Client/LinkBattleNetAccountLinks the Battle.net account associated with the token to the user's PlayFab account.
  • POSTLinkCustomID/Client/LinkCustomIDLinks the custom identifier, generated by the title, to the user's PlayFab account
  • POSTLinkFacebookAccount/Client/LinkFacebookAccountLinks the Facebook account associated with the provided Facebook access token to the user's PlayFab account
  • POSTLinkFacebookInstantGamesId/Client/LinkFacebookInstantGamesIdLinks the Facebook Instant Games Id to the user's PlayFab account
  • POSTLinkGameCenterAccount/Client/LinkGameCenterAccountLinks the Game Center account associated with the provided Game Center ID to the user's PlayFab account. Logging in with a Game Center ID is insecure if you…
  • POSTLinkGoogleAccount/Client/LinkGoogleAccountLinks the currently signed-in user account to their Google account, using their Google account credentials
  • POSTLinkGooglePlayGamesServicesAccount/Client/LinkGooglePlayGamesServicesAccountLinks the currently signed-in user account to their Google Play Games account, using their Google Play Games account credentials
  • POSTLinkIOSDeviceID/Client/LinkIOSDeviceIDLinks the vendor-specific iOS device identifier to the user's PlayFab account
  • POSTLinkKongregate/Client/LinkKongregateLinks the Kongregate identifier to the user's PlayFab account
  • POSTLinkNintendoServiceAccount/Client/LinkNintendoServiceAccountLinks the Nintendo account associated with the token to the user's PlayFab account.
  • POSTLinkNintendoSwitchDeviceId/Client/LinkNintendoSwitchDeviceIdLinks the NintendoSwitchDeviceId to the user's PlayFab account
  • POSTLinkOpenIdConnect/Client/LinkOpenIdConnectLinks an OpenID Connect account to a user's PlayFab account, based on an existing relationship between a title and an Open ID Connect provider and the OpenId…
  • POSTLinkPSNAccount/Client/LinkPSNAccountLinks the PlayStation :tm: Network account associated with the provided access code to the user's PlayFab account
  • POSTLinkSteamAccount/Client/LinkSteamAccountLinks the Steam account associated with the provided Steam authentication ticket to the user's PlayFab account
  • POSTLinkTwitch/Client/LinkTwitchLinks the Twitch account associated with the token to the user's PlayFab account.
  • POSTLinkXboxAccount/Client/LinkXboxAccountLinks the Xbox Live account associated with the provided access code to the user's PlayFab account
  • POSTRemoveContactEmail/Client/RemoveContactEmailRemoves a contact email from the player's profile.
  • POSTRemoveGenericID/Client/RemoveGenericIDRemoves the specified generic service identifier from the player's PlayFab account.
  • POSTReportPlayer/Client/ReportPlayerSubmit a report for another player (due to bad bahavior, etc.), so that customer service representatives for the title can take action concerning potentially…
  • POSTSendAccountRecoveryEmail/Client/SendAccountRecoveryEmailForces an email to be sent to the registered email address for the user's account, with a link allowing the user to change the password.If an account recovery…
  • POSTUnlinkAndroidDeviceID/Client/UnlinkAndroidDeviceIDUnlinks the related Android device identifier from the user's PlayFab account
  • POSTUnlinkApple/Client/UnlinkAppleUnlinks the related Apple account from the user's PlayFab account.
  • POSTUnlinkBattleNetAccount/Client/UnlinkBattleNetAccountUnlinks the related Battle.net account from the user's PlayFab account.
  • POSTUnlinkCustomID/Client/UnlinkCustomIDUnlinks the related custom identifier from the user's PlayFab account
  • POSTUnlinkFacebookAccount/Client/UnlinkFacebookAccountUnlinks the related Facebook account from the user's PlayFab account
  • POSTUnlinkFacebookInstantGamesId/Client/UnlinkFacebookInstantGamesIdUnlinks the related Facebook Instant Game Ids from the user's PlayFab account
  • POSTUnlinkGameCenterAccount/Client/UnlinkGameCenterAccountUnlinks the related Game Center account from the user's PlayFab account
  • POSTUnlinkGoogleAccount/Client/UnlinkGoogleAccountUnlinks the related Google account from the user's PlayFab account…
  • POSTUnlinkGooglePlayGamesServicesAccount/Client/UnlinkGooglePlayGamesServicesAccountUnlinks the related Google Play Games account from the user's PlayFab account.
  • POSTUnlinkIOSDeviceID/Client/UnlinkIOSDeviceIDUnlinks the related iOS device identifier from the user's PlayFab account
  • POSTUnlinkKongregate/Client/UnlinkKongregateUnlinks the related Kongregate identifier from the user's PlayFab account
  • POSTUnlinkNintendoServiceAccount/Client/UnlinkNintendoServiceAccountUnlinks the related Nintendo account from the user's PlayFab account.
  • POSTUnlinkNintendoSwitchDeviceId/Client/UnlinkNintendoSwitchDeviceIdUnlinks the related NintendoSwitchDeviceId from the user's PlayFab account
  • POSTUnlinkOpenIdConnect/Client/UnlinkOpenIdConnectUnlinks an OpenID Connect account from a user's PlayFab account, based on the connection ID of an existing relationship between a title and an Open ID Connect…
  • POSTUnlinkPSNAccount/Client/UnlinkPSNAccountUnlinks the related PlayStation :tm: Network account from the user's PlayFab account
  • POSTUnlinkSteamAccount/Client/UnlinkSteamAccountUnlinks the related Steam account from the user's PlayFab account
  • POSTUnlinkTwitch/Client/UnlinkTwitchUnlinks the related Twitch account from the user's PlayFab account.
  • POSTUnlinkXboxAccount/Client/UnlinkXboxAccountUnlinks the related Xbox Live account from the user's PlayFab account
  • POSTUpdateAvatarUrl/Client/UpdateAvatarUrlUpdate the avatar URL of the player
  • POSTUpdateUserTitleDisplayName/Client/UpdateUserTitleDisplayNameUpdates the title specific display name for the user

Advertising

  • POSTAttributeInstall/Client/AttributeInstallAttributes an install for advertisment.
  • POSTGetAdPlacements/Client/GetAdPlacementsReturns a list of ad placements and a reward for each
  • POSTReportAdActivity/Client/ReportAdActivityReport player's ad activity
  • POSTRewardAdActivity/Client/RewardAdActivityReward player's ad activity

Analytics

  • POSTReportDeviceInfo/Client/ReportDeviceInfoWrite a PlayStream event to describe the provided player device information. This API method is not designed to be called directly by developers. Each PlayFab…
  • POSTWriteCharacterEvent/Client/WriteCharacterEventWrites a character-based event into PlayStream.
  • POSTWritePlayerEvent/Client/WritePlayerEventWrites a player-based event into PlayStream.
  • POSTWriteTitleEvent/Client/WriteTitleEventWrites a title-based event into PlayStream.

Authentication

  • POSTGetPhotonAuthenticationToken/Client/GetPhotonAuthenticationTokenGets a Photon custom authentication token that can be used to securely join the player into a Photon room. See…
  • POSTGetTitlePublicKey/Client/GetTitlePublicKeyReturns the title's base 64 encoded RSA CSP blob.
  • POSTLoginWithAndroidDeviceID/Client/LoginWithAndroidDeviceIDSigns the user in using the Android device identifier, returning a session identifier that can subsequently be used for API calls which require an…
  • POSTLoginWithApple/Client/LoginWithAppleSigns in the user with a Sign in with Apple identity token.
  • POSTLoginWithBattleNet/Client/LoginWithBattleNetSign in the user with a Battle.net identity token
  • POSTLoginWithCustomID/Client/LoginWithCustomIDSigns the user in using a custom unique identifier generated by the title, returning a session identifier that can subsequently be used for API calls which…
  • POSTLoginWithEmailAddress/Client/LoginWithEmailAddressSigns the user into the PlayFab account, returning a session identifier that can subsequently be used for API calls which require an authenticated user.…
  • POSTLoginWithFacebook/Client/LoginWithFacebookSigns the user in using a Facebook access token, returning a session identifier that can subsequently be used for API calls which require an authenticated user
  • POSTLoginWithFacebookInstantGamesId/Client/LoginWithFacebookInstantGamesIdSigns the user in using a Facebook Instant Games ID, returning a session identifier that can subsequently be used for API calls which require an authenticated…
  • POSTLoginWithGameCenter/Client/LoginWithGameCenterSigns the user in using an iOS Game Center player identifier, returning a session identifier that can subsequently be used for API calls which require an…
  • POSTLoginWithGoogleAccount/Client/LoginWithGoogleAccountSigns the user in using their Google account credentials
  • POSTLoginWithGooglePlayGamesServices/Client/LoginWithGooglePlayGamesServicesSigns the user in using their Google Play Games account credentials
  • POSTLoginWithIOSDeviceID/Client/LoginWithIOSDeviceIDSigns the user in using the vendor-specific iOS device identifier, returning a session identifier that can subsequently be used for API calls which require an…
  • POSTLoginWithKongregate/Client/LoginWithKongregateSigns the user in using a Kongregate player account.
  • POSTLoginWithNintendoServiceAccount/Client/LoginWithNintendoServiceAccountSigns in the user with a Nintendo service account token.
  • POSTLoginWithNintendoSwitchDeviceId/Client/LoginWithNintendoSwitchDeviceIdSigns the user in using a Nintendo Switch Device ID, returning a session identifier that can subsequently be used for API calls which require an authenticated…
  • POSTLoginWithOpenIdConnect/Client/LoginWithOpenIdConnectLogs in a user with an Open ID Connect JWT created by an existing relationship between a title and an Open ID Connect provider.
  • POSTLoginWithPlayFab/Client/LoginWithPlayFabSigns the user into the PlayFab account, returning a session identifier that can subsequently be used for API calls which require an authenticated user.…
  • POSTLoginWithPSN/Client/LoginWithPSNSigns the user in using a PlayStation :tm: Network authentication code, returning a session identifier that can subsequently be used for API calls which…
  • POSTLoginWithSteam/Client/LoginWithSteamSigns the user in using a Steam authentication ticket, returning a session identifier that can subsequently be used for API calls which require an…
  • POSTLoginWithTwitch/Client/LoginWithTwitchSigns the user in using a Twitch access token.
  • POSTLoginWithXbox/Client/LoginWithXboxSigns the user in using a Xbox Live Token, returning a session identifier that can subsequently be used for API calls which require an authenticated user
  • POSTRegisterPlayFabUser/Client/RegisterPlayFabUserRegisters a new Playfab user account, returning a session identifier that can subsequently be used for API calls which require an authenticated user. You must…
  • POSTSetPlayerSecret/Client/SetPlayerSecretSets the player's secret if it is not already set. Player secrets are used to sign API requests. To reset a player's secret use the Admin or Server API method…

Character Data

  • POSTGetCharacterData/Client/GetCharacterDataRetrieves the title-specific custom data for the character which is readable and writable by the client
  • POSTGetCharacterReadOnlyData/Client/GetCharacterReadOnlyDataRetrieves the title-specific custom data for the character which can only be read by the client
  • POSTUpdateCharacterData/Client/UpdateCharacterDataCreates and updates the title-specific custom data for the user's character which is readable and writable by the client

Characters

  • POSTGetAllUsersCharacters/Client/GetAllUsersCharactersLists all of the characters that belong to a specific user. CharacterIds are not globally unique; characterId must be evaluated with the parent PlayFabId to…
  • POSTGetCharacterLeaderboard/Client/GetCharacterLeaderboardRetrieves a list of ranked characters for the given statistic, starting from the indicated point in the leaderboard
  • POSTGetCharacterStatistics/Client/GetCharacterStatisticsRetrieves the details of all title-specific statistics for the user
  • POSTGetLeaderboardAroundCharacter/Client/GetLeaderboardAroundCharacterRetrieves a list of ranked characters for the given statistic, centered on the requested Character ID
  • POSTGetLeaderboardForUserCharacters/Client/GetLeaderboardForUserCharactersRetrieves a list of all of the user's characters for the given statistic.
  • POSTGrantCharacterToUser/Client/GrantCharacterToUserGrants the specified character type to the user. CharacterIds are not globally unique; characterId must be evaluated with the parent PlayFabId to guarantee…
  • POSTUpdateCharacterStatistics/Client/UpdateCharacterStatisticsUpdates the values of the specified title-specific statistics for the specific character. By default, clients are not permitted to update statistics.…

Content

  • POSTGetContentDownloadUrl/Client/GetContentDownloadUrlThis API retrieves a pre-signed URL for accessing a content file for the title. A subsequent HTTP GET to the returned URL will attempt to download the…

Friend List Management

  • POSTAddFriend/Client/AddFriendAdds the PlayFab user, based upon a match against a supplied unique identifier, to the friend list of the local user. At least one of…
  • POSTGetFriendsList/Client/GetFriendsListRetrieves the current friend list for the local user, constrained to users who have PlayFab accounts. Friends from linked accounts (Facebook, Steam) are also…
  • POSTRemoveFriend/Client/RemoveFriendRemoves a specified user from the friend list of the local user
  • POSTSetFriendTags/Client/SetFriendTagsUpdates the tag list for a specified user in the friend list of the local user

Platform Specific Methods

  • POSTAndroidDevicePushNotificationRegistration/Client/AndroidDevicePushNotificationRegistrationRegisters the Android device to receive push notifications
  • POSTConsumeMicrosoftStoreEntitlements/Client/ConsumeMicrosoftStoreEntitlementsGrants the player's current entitlements from Microsoft Store's Collection API
  • POSTConsumePS5Entitlements/Client/ConsumePS5EntitlementsChecks for any new consumable entitlements. If any are found, they are consumed (if they're consumables) and added as PlayFab items
  • POSTConsumePSNEntitlements/Client/ConsumePSNEntitlementsChecks for any new consumable entitlements. If any are found, they are consumed and added as PlayFab items
  • POSTConsumeXboxEntitlements/Client/ConsumeXboxEntitlementsGrants the player's current entitlements from Xbox Live, consuming all availble items in Xbox and granting them to the player's PlayFab inventory. This call…
  • POSTRefreshPSNAuthToken/Client/RefreshPSNAuthTokenUses the supplied OAuth code to refresh the internally cached player PlayStation :tm: Network auth token
  • POSTRegisterForIOSPushNotification/Client/RegisterForIOSPushNotificationRegisters the iOS device to receive push notifications
  • POSTRestoreIOSPurchases/Client/RestoreIOSPurchases_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Restores all in-app…
  • POSTValidateAmazonIAPReceipt/Client/ValidateAmazonIAPReceipt_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Validates with Amazon that…
  • POSTValidateGooglePlayPurchase/Client/ValidateGooglePlayPurchase_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Validates a Google Play…
  • POSTValidateIOSReceipt/Client/ValidateIOSReceipt_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Validates with the Apple…
  • POSTValidateWindowsStoreReceipt/Client/ValidateWindowsStoreReceipt_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Validates with Windows that…

Player Data Management

  • POSTDeletePlayerCustomProperties/Client/DeletePlayerCustomPropertiesDeletes title-specific custom properties for a player
  • POSTGetFriendLeaderboard/Client/GetFriendLeaderboardRetrieves a list of ranked friends of the current player for the given statistic, starting from the indicated point in the leaderboard
  • POSTGetFriendLeaderboardAroundPlayer/Client/GetFriendLeaderboardAroundPlayerRetrieves a list of ranked friends of the current player for the given statistic, centered on the requested PlayFab user. If PlayFabId is empty or null will…
  • POSTGetLeaderboard/Client/GetLeaderboardRetrieves a list of ranked users for the given statistic, starting from the indicated point in the leaderboard
  • POSTGetLeaderboardAroundPlayer/Client/GetLeaderboardAroundPlayerRetrieves a list of ranked users for the given statistic, centered on the requested player. If PlayFabId is empty or null will return currently logged in user.
  • POSTGetPlayerCustomProperty/Client/GetPlayerCustomPropertyRetrieves a title-specific custom property value for a player.
  • POSTGetPlayerStatistics/Client/GetPlayerStatisticsRetrieves the indicated statistics (current version and values for all statistics, if none are specified), for the local player.
  • POSTGetPlayerStatisticVersions/Client/GetPlayerStatisticVersionsRetrieves the information on the available versions of the specified statistic.
  • POSTGetUserData/Client/GetUserDataRetrieves the title-specific custom data for the user which is readable and writable by the client
  • POSTGetUserPublisherData/Client/GetUserPublisherDataRetrieves the publisher-specific custom data for the user which is readable and writable by the client
  • POSTGetUserPublisherReadOnlyData/Client/GetUserPublisherReadOnlyDataRetrieves the publisher-specific custom data for the user which can only be read by the client
  • POSTGetUserReadOnlyData/Client/GetUserReadOnlyDataRetrieves the title-specific custom data for the user which can only be read by the client
  • POSTListPlayerCustomProperties/Client/ListPlayerCustomPropertiesRetrieves title-specific custom property values for a player.
  • POSTUpdatePlayerCustomProperties/Client/UpdatePlayerCustomPropertiesUpdates the title-specific custom property values for a player
  • POSTUpdatePlayerStatistics/Client/UpdatePlayerStatisticsUpdates the values of the specified title-specific statistics for the user. By default, clients are not permitted to update statistics. Developers may…
  • POSTUpdateUserData/Client/UpdateUserDataCreates and updates the title-specific custom data for the user which is readable and writable by the client
  • POSTUpdateUserPublisherData/Client/UpdateUserPublisherDataCreates and updates the publisher-specific custom data for the user which is readable and writable by the client

Player Item Management

  • POSTAddUserVirtualCurrency/Client/AddUserVirtualCurrency_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Increments the user's…
  • POSTConfirmPurchase/Client/ConfirmPurchase_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Confirms with the payment…
  • POSTConsumeItem/Client/ConsumeItem_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Consume uses of a…
  • POSTGetCharacterInventory/Client/GetCharacterInventory_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Retrieves the specified…
  • POSTGetPaymentToken/Client/GetPaymentToken_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ For payments flows where…
  • POSTGetPurchase/Client/GetPurchase_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Retrieves a purchase along…
  • POSTGetUserInventory/Client/GetUserInventory_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Retrieves the user's…
  • POSTPayForPurchase/Client/PayForPurchase_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Selects a payment option…
  • POSTPurchaseItem/Client/PurchaseItem_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Buys a single item with…
  • POSTRedeemCoupon/Client/RedeemCoupon_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Adds the virtual goods…
  • POSTStartPurchase/Client/StartPurchase_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Creates an order for a list…
  • POSTSubtractUserVirtualCurrency/Client/SubtractUserVirtualCurrency_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Decrements the user's…
  • POSTUnlockContainerInstance/Client/UnlockContainerInstance_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Opens the specified…
  • POSTUnlockContainerItem/Client/UnlockContainerItem_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Searches target inventory…

PlayStream

  • POSTGetPlayerSegments/Client/GetPlayerSegmentsList all segments that a player currently belongs to at this moment in time.
  • POSTGetPlayerTags/Client/GetPlayerTagsGet all tags with a given Namespace (optional) from a player profile.

Server-Side Cloud Script

  • POSTExecuteCloudScript/Client/ExecuteCloudScriptExecutes a CloudScript function, with the 'currentPlayerId' set to the PlayFab ID of the authenticated player. The PlayFab ID is the entity ID of the player's…

Shared Group Data

  • POSTAddSharedGroupMembers/Client/AddSharedGroupMembersAdds users to the set of those able to update both the shared data, as well as the set of users in the group. Only users in the group can add new members.…
  • POSTCreateSharedGroup/Client/CreateSharedGroupRequests the creation of a shared group object, containing key/value pairs which may be updated by all members of the group. Upon creation, the current user…
  • POSTGetSharedGroupData/Client/GetSharedGroupDataRetrieves data stored in a shared group object, as well as the list of members in the group. Non-members of the group may use this to retrieve group data,…
  • POSTRemoveSharedGroupMembers/Client/RemoveSharedGroupMembersRemoves users from the set of those able to update the shared data and the set of users in the group. Only users in the group can remove members. If as a…
  • POSTUpdateSharedGroupData/Client/UpdateSharedGroupDataAdds, updates, and removes data keys for a shared group object. If the permission is set to Public, all fields updated or added in this call will be readable…

Title-Wide Data Management

  • POSTGetCatalogItems/Client/GetCatalogItems_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Retrieves the specified…
  • POSTGetPublisherData/Client/GetPublisherDataRetrieves the key-value store of custom publisher settings
  • POSTGetStoreItems/Client/GetStoreItems_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Retrieves the set of items…
  • POSTGetTime/Client/GetTimeRetrieves the current server time
  • POSTGetTitleData/Client/GetTitleDataRetrieves the key-value store of custom title settings
  • POSTGetTitleNews/Client/GetTitleNewsRetrieves the title news feed, as configured in the developer portal

Trading

  • POSTAcceptTrade/Client/AcceptTradeAccepts an open trade (one that has not yet been accepted or cancelled), if the locally signed-in player is in the allowed player list for the trade, or it is…
  • POSTCancelTrade/Client/CancelTradeCancels an open trade (one that has not yet been accepted or cancelled). Note that only the player who created the trade can cancel it via this API call, to…
  • POSTGetPlayerTrades/Client/GetPlayerTradesGets all trades the player has either opened or accepted, optionally filtered by trade status.
  • POSTGetTradeStatus/Client/GetTradeStatusGets the current status of an existing trade.
  • POSTOpenTrade/Client/OpenTradeOpens a new outstanding trade. Note that a given item instance may only be in one open trade at a time.

API details

Base URL
https://titleId.playfabapi.com
Authentication
An API key in the None header
An API key in the X-Authorization header
An API key in the X-SecretKey header
An API key in the X-EntityToken header
Operations
174 operations on 174 pathsPOST 174
Main resources
Account Management 65Authentication 24Player Data Management 17Player Item Management 14Platform Specific Methods 12Characters 7Title-Wide Data Management 6Shared Group Data 5Trading 5Advertising 4
Response formats
application/json
Description format
Swagger 2.0, API version 260922

How to test the PlayFab Client API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the PlayFab Client API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the None header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “AddGenericID” (POST /Client/AddGenericID), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the PlayFab Client API?

APIs which provide the full range of PlayFab features available to the client - authentication, account and data management, inventory, friends, matchmaking,… It is listed under Media & content and has 174 endpoints.

Who publishes the PlayFab Client API?

It is listed from PlayFab's public API description (an OpenAPI document), not published by PlayFab on Swastik Codes. Anyone who controls playfab.com can claim the profile by adding a DNS TXT record.

What is the base URL of the PlayFab Client API?

Requests go to https://titleId.playfabapi.com. Endpoint paths are added to this base URL.

How do I authenticate with the PlayFab Client API?

It accepts 4 methods: an API key in the None header; an API key in the X-Authorization header; an API key in the X-SecretKey header; an API key in the X-EntityToken header.

How many endpoints does the PlayFab Client API have?

174 operations on 174 paths (174 POST). The largest groups are Account Management, Authentication, Player Data Management, Player Item Management.

Is forking the PlayFab Client API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.