PlayFab Server API
Provides functionality to allow external (developer-controlled) servers to interact with user inventories and data in a trusted manner, and to handle…
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
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
Endpoints 162
Account Management
- POSTAddGenericID
/Server/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
/Server/AddOrUpdateContactEmailAdds or updates a contact email to the specified player's profile. - POSTBanUsers
/Server/BanUsersBans users by PlayFab ID with optional IP address for the provided game. - POSTDeletePlayer
/Server/DeletePlayerRemoves a user's player account from a title and deletes all associated data - POSTDeletePushNotificationTemplate
/Server/DeletePushNotificationTemplateDeletes push notification template for title - POSTGetPlayerProfile
/Server/GetPlayerProfileRetrieves the player's profile - POSTGetPlayFabIDsFromBattleNetAccountIds
/Server/GetPlayFabIDsFromBattleNetAccountIdsRetrieves the unique PlayFab identifiers for the given set of Battle.net account identifiers. - POSTGetPlayFabIDsFromFacebookIDs
/Server/GetPlayFabIDsFromFacebookIDsRetrieves the unique PlayFab identifiers for the given set of Facebook identifiers. - POSTGetPlayFabIDsFromFacebookInstantGamesIds
/Server/GetPlayFabIDsFromFacebookInstantGamesIdsRetrieves the unique PlayFab identifiers for the given set of Facebook Instant Games identifiers. - POSTGetPlayFabIDsFromGenericIDs
/Server/GetPlayFabIDsFromGenericIDsRetrieves the unique PlayFab identifiers for the given set of generic service identifiers. A generic identifier is the service name plus the service-specific… - POSTGetPlayFabIDsFromNintendoServiceAccountIds
/Server/GetPlayFabIDsFromNintendoServiceAccountIdsRetrieves the unique PlayFab identifiers for the given set of Nintendo Service Account identifiers. - POSTGetPlayFabIDsFromNintendoSwitchDeviceIds
/Server/GetPlayFabIDsFromNintendoSwitchDeviceIdsRetrieves the unique PlayFab identifiers for the given set of Nintendo Switch Device identifiers. - POSTGetPlayFabIDsFromOpenIdSubjectIdentifiers
/Server/GetPlayFabIDsFromOpenIdSubjectIdentifiersRetrieves the unique PlayFab identifiers for the given set of OpenId subject identifiers. A OpenId subject identifier is the OpenId issuer plus the OpenId… - POSTGetPlayFabIDsFromPSNAccountIDs
/Server/GetPlayFabIDsFromPSNAccountIDsRetrieves the unique PlayFab identifiers for the given set of PlayStation :tm: Network identifiers. - POSTGetPlayFabIDsFromPSNOnlineIDs
/Server/GetPlayFabIDsFromPSNOnlineIDsRetrieves the unique PlayFab identifiers for the given set of PlayStation :tm: Network identifiers. - POSTGetPlayFabIDsFromServerCustomIDs
/Server/GetPlayFabIDsFromServerCustomIDsRetrieves the associated PlayFab account identifiers for the given set of server custom player identifiers. - POSTGetPlayFabIDsFromSteamIDs
/Server/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
/Server/GetPlayFabIDsFromSteamNamesRetrieves the unique PlayFab identifiers for the given set of Steam identifiers. The Steam identifiers are persona names. - POSTGetPlayFabIDsFromTwitchIDs
/Server/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
/Server/GetPlayFabIDsFromXboxLiveIDsRetrieves the unique PlayFab identifiers for the given set of XboxLive identifiers. - POSTGetServerCustomIDsFromPlayFabIDs
/Server/GetServerCustomIDsFromPlayFabIDsRetrieves the associated PlayFab account identifiers for the given set of server custom identifiers. - POSTGetUserAccountInfo
/Server/GetUserAccountInfoRetrieves the relevant details for a specified user - POSTGetUserBans
/Server/GetUserBansGets all bans for a user. - POSTLinkBattleNetAccount
/Server/LinkBattleNetAccountLinks the Battle.net account associated with the token to the user's PlayFab account. - POSTLinkNintendoServiceAccount
/Server/LinkNintendoServiceAccountLinks the Nintendo account associated with the token to the user's PlayFab account - POSTLinkNintendoServiceAccountSubject
/Server/LinkNintendoServiceAccountSubjectLinks the Nintendo account associated with the Nintendo Service Account subject or id to the user's PlayFab account - POSTLinkNintendoSwitchDeviceId
/Server/LinkNintendoSwitchDeviceIdLinks the NintendoSwitchDeviceId to the user's PlayFab account - POSTLinkPSNAccount
/Server/LinkPSNAccountLinks the PlayStation :tm: Network account associated with the provided access code to the user's PlayFab account - POSTLinkPSNId
/Server/LinkPSNIdLinks the PlayStation :tm: Network account associated with the provided user id to the user's PlayFab account - POSTLinkServerCustomId
/Server/LinkServerCustomIdLinks the custom server identifier, generated by the title, to the user's PlayFab account. - POSTLinkSteamId
/Server/LinkSteamIdLinks the Steam account associated with the provided Steam ID to the user's PlayFab account - POSTLinkTwitchAccount
/Server/LinkTwitchAccountLinks the Twitch account associated with the token to the user's PlayFab account. - POSTLinkXboxAccount
/Server/LinkXboxAccountLinks the Xbox Live account associated with the provided access code to the user's PlayFab account - POSTLinkXboxId
/Server/LinkXboxIdLinks the Xbox Live account associated with the provided Xbox ID and Sandbox to the user's PlayFab account - POSTRemoveGenericID
/Server/RemoveGenericIDRemoves the specified generic service identifier from the player's PlayFab account. - POSTRevokeAllBansForUser
/Server/RevokeAllBansForUserRevoke all active bans for a user. - POSTRevokeBans
/Server/RevokeBansRevoke all active bans specified with BanId. - POSTSavePushNotificationTemplate
/Server/SavePushNotificationTemplateSaves push notification template for title - POSTSendCustomAccountRecoveryEmail
/Server/SendCustomAccountRecoveryEmailForces an email to be sent to the registered contact email address for the user's account based on an account recovery email template - POSTSendEmailFromTemplate
/Server/SendEmailFromTemplateSends an email based on an email template to a player's contact email - POSTSendPushNotification
/Server/SendPushNotificationSends an iOS/Android Push Notification to a specific user, if that user's device has been configured for Push Notifications in PlayFab. If a user has linked… - POSTSendPushNotificationFromTemplate
/Server/SendPushNotificationFromTemplateSends an iOS/Android Push Notification template to a specific user, if that user's device has been configured for Push Notifications in PlayFab. If a user has… - POSTUnlinkApple
/Server/UnlinkAppleUnlinks the related Apple account from the specified user's PlayFab account. - POSTUnlinkBattleNetAccount
/Server/UnlinkBattleNetAccountUnlinks the related Battle.net account from the user's PlayFab account. - POSTUnlinkFacebookAccount
/Server/UnlinkFacebookAccountUnlinks the related Facebook account from the user's PlayFab account - POSTUnlinkFacebookInstantGamesId
/Server/UnlinkFacebookInstantGamesIdUnlinks the related Facebook Instant Games identifier from the user's PlayFab account - POSTUnlinkGameCenterAccount
/Server/UnlinkGameCenterAccountUnlinks the related Game Center account from the specified user's PlayFab account. - POSTUnlinkNintendoServiceAccount
/Server/UnlinkNintendoServiceAccountUnlinks the related Nintendo account from the user's PlayFab account - POSTUnlinkNintendoSwitchDeviceId
/Server/UnlinkNintendoSwitchDeviceIdUnlinks the related NintendoSwitchDeviceId from the user's PlayFab account - POSTUnlinkPSNAccount
/Server/UnlinkPSNAccountUnlinks the related PlayStation :tm: Network account from the user's PlayFab account - POSTUnlinkServerCustomId
/Server/UnlinkServerCustomIdUnlinks the custom server identifier from the user's PlayFab account. - POSTUnlinkSteamId
/Server/UnlinkSteamIdUnlinks the Steam account associated with the provided Steam ID to the user's PlayFab account - POSTUnlinkTwitchAccount
/Server/UnlinkTwitchAccountUnlinks the related Twitch account from the user's PlayFab account. - POSTUnlinkXboxAccount
/Server/UnlinkXboxAccountUnlinks the related Xbox Live account from the user's PlayFab account - POSTUpdateAvatarUrl
/Server/UpdateAvatarUrlUpdate the avatar URL of the specified player - POSTUpdateBans
/Server/UpdateBansUpdates information of a list of existing bans specified with Ban Ids.
Analytics
- POSTWriteCharacterEvent
/Server/WriteCharacterEventWrites a character-based event into PlayStream. - POSTWritePlayerEvent
/Server/WritePlayerEventWrites a player-based event into PlayStream. - POSTWriteTitleEvent
/Server/WriteTitleEventWrites a title-based event into PlayStream.
Authentication
- POSTAuthenticateSessionTicket
/Server/AuthenticateSessionTicketValidated a client's session ticket, and if successful, returns details for that user - POSTLoginWithAndroidDeviceID
/Server/LoginWithAndroidDeviceIDSigns the user in using the Android device identifier, returning a session identifier that can subsequently be used for API calls which require an… - POSTLoginWithBattleNet
/Server/LoginWithBattleNetSign in the user with a Battle.net identity token - POSTLoginWithCustomID
/Server/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… - POSTLoginWithIOSDeviceID
/Server/LoginWithIOSDeviceIDSigns the user in using the iOS device identifier, returning a session identifier that can subsequently be used for API calls which require an authenticated… - POSTLoginWithPSN
/Server/LoginWithPSNSigns the user in using a PlayStation :tm: Network authentication code, returning a session identifier that can subsequently be used for API calls which… - POSTLoginWithServerCustomId
/Server/LoginWithServerCustomIdSecurely login a game client from an external server backend using a custom identifier for that player. Server Custom ID and Client Custom ID are mutually… - POSTLoginWithSteamId
/Server/LoginWithSteamIdSigns the user in using an Steam ID, returning a session identifier that can subsequently be used for API calls which require an authenticated user - POSTLoginWithTwitch
/Server/LoginWithTwitchSign in the user with a Twitch access token - POSTLoginWithXbox
/Server/LoginWithXboxSigns the user in using a Xbox Live Token from an external server backend, returning a session identifier that can subsequently be used for API calls which… - POSTLoginWithXboxId
/Server/LoginWithXboxIdSigns the user in using an Xbox ID and Sandbox ID, returning a session identifier that can subsequently be used for API calls which require an authenticated… - POSTSetPlayerSecret
/Server/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
/Server/GetCharacterDataRetrieves the title-specific custom data for the user which is readable and writable by the client - POSTGetCharacterInternalData
/Server/GetCharacterInternalDataRetrieves the title-specific custom data for the user's character which cannot be accessed by the client - POSTGetCharacterReadOnlyData
/Server/GetCharacterReadOnlyDataRetrieves the title-specific custom data for the user's character which can only be read by the client - POSTUpdateCharacterData
/Server/UpdateCharacterDataUpdates the title-specific custom data for the user's character which is readable and writable by the client - POSTUpdateCharacterInternalData
/Server/UpdateCharacterInternalDataUpdates the title-specific custom data for the user's character which cannot be accessed by the client - POSTUpdateCharacterReadOnlyData
/Server/UpdateCharacterReadOnlyDataUpdates the title-specific custom data for the user's character which can only be read by the client
Characters
- POSTDeleteCharacterFromUser
/Server/DeleteCharacterFromUserDeletes the specific character ID from the specified user. - POSTGetAllUsersCharacters
/Server/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
/Server/GetCharacterLeaderboardRetrieves a list of ranked characters for the given statistic, starting from the indicated point in the leaderboard - POSTGetCharacterStatistics
/Server/GetCharacterStatisticsRetrieves the details of all title-specific statistics for the specific character - POSTGetLeaderboardAroundCharacter
/Server/GetLeaderboardAroundCharacterRetrieves a list of ranked characters for the given statistic, centered on the requested user - POSTGetLeaderboardForUserCharacters
/Server/GetLeaderboardForUserCharactersRetrieves a list of all of the user's characters for the given statistic. - POSTGrantCharacterToUser
/Server/GrantCharacterToUserGrants the specified character type to the user. CharacterIds are not globally unique; characterId must be evaluated with the parent PlayFabId to guarantee… - POSTUpdateCharacterStatistics
/Server/UpdateCharacterStatisticsUpdates the values of the specified title-specific statistics for the specific character
Content
- POSTGetContentDownloadUrl
/Server/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
/Server/AddFriendAdds the Friend user to the friendlist of the user with PlayFabId. At least one of FriendPlayFabId,FriendUsername,FriendEmail, or FriendTitleDisplayName… - POSTGetFriendsList
/Server/GetFriendsListRetrieves the current friends for the user with PlayFabId, constrained to users who have PlayFab accounts. Friends from linked accounts (Facebook, Steam) are… - POSTRemoveFriend
/Server/RemoveFriendRemoves the specified friend from the the user's friend list - POSTSetFriendTags
/Server/SetFriendTagsUpdates the tag list for a specified user in the friend list of another user
Platform Specific Methods
- POSTAwardSteamAchievement
/Server/AwardSteamAchievementAwards the specified users the specified Steam achievements
Player Data Management
- POSTDeletePlayerCustomProperties
/Server/DeletePlayerCustomPropertiesDeletes title-specific custom properties for a player - POSTGetFriendLeaderboard
/Server/GetFriendLeaderboardRetrieves a list of ranked friends of the given player for the given statistic, starting from the indicated point in the leaderboard - POSTGetLeaderboard
/Server/GetLeaderboardRetrieves a list of ranked users for the given statistic, starting from the indicated point in the leaderboard - POSTGetLeaderboardAroundUser
/Server/GetLeaderboardAroundUserRetrieves a list of ranked users for the given statistic, centered on the currently signed-in user - POSTGetPlayerCombinedInfo
/Server/GetPlayerCombinedInfoReturns whatever info is requested in the response for the user. Note that PII (like email address, facebook id) may be returned. All parameters default to… - POSTGetPlayerCustomProperty
/Server/GetPlayerCustomPropertyRetrieves a title-specific custom property value for a player. - POSTGetPlayerStatistics
/Server/GetPlayerStatisticsRetrieves the current version and values for the indicated statistics, for the local player. - POSTGetPlayerStatisticVersions
/Server/GetPlayerStatisticVersionsRetrieves the information on the available versions of the specified statistic. - POSTGetUserData
/Server/GetUserDataRetrieves the title-specific custom data for the user which is readable and writable by the client - POSTGetUserInternalData
/Server/GetUserInternalDataRetrieves the title-specific custom data for the user which cannot be accessed by the client - POSTGetUserPublisherData
/Server/GetUserPublisherDataRetrieves the publisher-specific custom data for the user which is readable and writable by the client - POSTGetUserPublisherInternalData
/Server/GetUserPublisherInternalDataRetrieves the publisher-specific custom data for the user which cannot be accessed by the client - POSTGetUserPublisherReadOnlyData
/Server/GetUserPublisherReadOnlyDataRetrieves the publisher-specific custom data for the user which can only be read by the client - POSTGetUserReadOnlyData
/Server/GetUserReadOnlyDataRetrieves the title-specific custom data for the user which can only be read by the client - POSTListPlayerCustomProperties
/Server/ListPlayerCustomPropertiesRetrieves title-specific custom property values for a player. - POSTUpdatePlayerCustomProperties
/Server/UpdatePlayerCustomPropertiesUpdates the title-specific custom property values for a player - POSTUpdatePlayerStatistics
/Server/UpdatePlayerStatisticsUpdates the values of the specified title-specific statistics for the user - POSTUpdateUserData
/Server/UpdateUserDataUpdates the title-specific custom data for the user which is readable and writable by the client - POSTUpdateUserInternalData
/Server/UpdateUserInternalDataUpdates the title-specific custom data for the user which cannot be accessed by the client - POSTUpdateUserPublisherData
/Server/UpdateUserPublisherDataUpdates the publisher-specific custom data for the user which is readable and writable by the client - POSTUpdateUserPublisherInternalData
/Server/UpdateUserPublisherInternalDataUpdates the publisher-specific custom data for the user which cannot be accessed by the client - POSTUpdateUserPublisherReadOnlyData
/Server/UpdateUserPublisherReadOnlyDataUpdates the publisher-specific custom data for the user which can only be read by the client - POSTUpdateUserReadOnlyData
/Server/UpdateUserReadOnlyDataUpdates the title-specific custom data for the user which can only be read by the client
Player Item Management
- POSTAddCharacterVirtualCurrency
/Server/AddCharacterVirtualCurrency_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 character's… - POSTAddUserVirtualCurrency
/Server/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… - POSTConsumeItem
/Server/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… - POSTEvaluateRandomResultTable
/Server/EvaluateRandomResultTable_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Returns the result of an… - POSTGetCharacterInventory
/Server/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… - POSTGetRandomResultTables
/Server/GetRandomResultTables_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 configuration… - POSTGetUserInventory
/Server/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 specified… - POSTGrantItemsToCharacter
/Server/GrantItemsToCharacter_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 specified items to… - POSTGrantItemsToUser
/Server/GrantItemsToUser_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 specified items to… - POSTGrantItemsToUsers
/Server/GrantItemsToUsers_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 specified items to… - POSTModifyItemUses
/Server/ModifyItemUses_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Modifies the number of… - POSTMoveItemToCharacterFromCharacter
/Server/MoveItemToCharacterFromCharacter_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Moves an item from a… - POSTMoveItemToCharacterFromUser
/Server/MoveItemToCharacterFromUser_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Moves an item from a user's… - POSTMoveItemToUserFromCharacter
/Server/MoveItemToUserFromCharacter_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Moves an item from a… - POSTRedeemCoupon
/Server/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… - POSTReportPlayer
/Server/ReportPlayerSubmit a report about a player (due to bad bahavior, etc.) on behalf of another player, so that customer service representatives for the title can take action… - POSTRevokeInventoryItem
/Server/RevokeInventoryItem_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Revokes access to an item… - POSTRevokeInventoryItems
/Server/RevokeInventoryItems_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Revokes access for up to 25… - POSTSubtractCharacterVirtualCurrency
/Server/SubtractCharacterVirtualCurrency_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 character's… - POSTSubtractUserVirtualCurrency
/Server/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
/Server/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 a specific container… - POSTUnlockContainerItem
/Server/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 Player or… - POSTUpdateUserInventoryItemCustomData
/Server/UpdateUserInventoryItemCustomData_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Updates the key-value pair…
PlayStream
- POSTAddPlayerTag
/Server/AddPlayerTagAdds a given tag to a player profile. The tag's namespace is automatically generated based on the source of the tag. - POSTExportPlayersInSegment
/Server/ExportPlayersInSegmentStarts an export for the player profiles in a segment. This API creates a snapshot of all the player profiles which match the segment definition at the time… - POSTGetAllSegments
/Server/GetAllSegmentsRetrieves an array of player segment definitions. Results from this can be used in subsequent API calls such as ExportPlayersInSegment which requires a… - POSTGetPlayerSegments
/Server/GetPlayerSegmentsList all segments that a player currently belongs to at this moment in time. - POSTGetPlayerTags
/Server/GetPlayerTagsGet all tags with a given Namespace (optional) from a player profile. - POSTGetSegmentExport
/Server/GetSegmentExportRetrieves the result of an export started by ExportPlayersInSegment API. If the ExportPlayersInSegment is successful and complete, this API returns the… - POSTGetSegmentPlayerCount
/Server/GetSegmentPlayerCountReturns the total number of players in a given segment. - POSTRemovePlayerTag
/Server/RemovePlayerTagRemove a given tag from a player profile. The tag's namespace is automatically generated based on the source of the tag.
Server-Side Cloud Script
- POSTExecuteCloudScript
/Server/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
/Server/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 (and the server) can add… - POSTCreateSharedGroup
/Server/CreateSharedGroupRequests the creation of a shared group object, containing key/value pairs which may be updated by all members of the group. When created by a server, the… - POSTDeleteSharedGroup
/Server/DeleteSharedGroupDeletes a shared group, freeing up the shared group ID to be reused for a new group. Shared Groups are designed for sharing data between a very small number… - POSTGetSharedGroupData
/Server/GetSharedGroupDataRetrieves data stored in a shared group object, as well as the list of members in the group. The server can access all public and private group data. Shared… - POSTRemoveSharedGroupMembers
/Server/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
/Server/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
/Server/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
/Server/GetPublisherDataRetrieves the key-value store of custom publisher settings - POSTGetStoreItems
/Server/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
/Server/GetTimeRetrieves the current server time - POSTGetTitleData
/Server/GetTitleDataRetrieves the key-value store of custom title settings - POSTGetTitleInternalData
/Server/GetTitleInternalDataRetrieves the key-value store of custom internal title settings - POSTGetTitleNews
/Server/GetTitleNewsRetrieves the title news feed, as configured in the developer portal - POSTSetPublisherData
/Server/SetPublisherDataUpdates the key-value store of custom publisher settings - POSTSetTitleData
/Server/SetTitleDataUpdates the key-value store of custom title settings - POSTSetTitleInternalData
/Server/SetTitleInternalDataUpdates the key-value store of custom title settings
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
- 162 operations on 162 pathsPOST 162
- Main resources
- Account Management 56Player Data Management 23Player Item Management 23Authentication 12Title-Wide Data Management 10Characters 8PlayStream 8Character Data 6Shared Group Data 6Friend List Management 4
- Response formats
application/json- Description format
- Swagger 2.0, API version
260922 - Links
- OpenAPI document · Terms of service · Support
- Listed from
- PlayFab's published OpenAPI description (PlayFab/API_Specs) (Apache-2.0)
How to test the PlayFab Server API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the PlayFab Server API collection, without the publisher's secrets.
- 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.
- Send a requestPick an endpoint, for example “AddGenericID” (POST /Server/AddGenericID), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the PlayFab Server API?
Provides functionality to allow external (developer-controlled) servers to interact with user inventories and data in a trusted manner, and to handle… It is listed under Media & content and has 162 endpoints.
Who publishes the PlayFab Server 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 Server API?
Requests go to https://titleId.playfabapi.com. Endpoint paths are added to this base URL.
How do I authenticate with the PlayFab Server 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 Server API have?
162 operations on 162 paths (162 POST). The largest groups are Account Management, Player Data Management, Player Item Management, Authentication.
Is forking the PlayFab Server API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.