Account Management - Get PlayFab IDs From Steam IDs

Service:

Server

API Version:

240412

Retrieves the unique PlayFab identifiers for the given set of Steam identifiers. The Steam identifiers are the profile IDs for the user accounts, available as SteamId in the Steamworks Community API calls.

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

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	Type	Description
SteamStringIDs	string[]	Array of unique Steam identifiers (Steam profile IDs) for which the title needs to get PlayFab identifiers. The array cannot exceed 2,000 in length.

Responses

Name	Type	Description
200 OK	GetPlayFabIDsFromSteamIDsResult	For Steam identifiers which have not been linked to PlayFab accounts, null will be returned.
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
ApiErrorWrapper	The basic wrapper around every failed API response
GetPlayFabIDsFromSteamIDsRequest
GetPlayFabIDsFromSteamIDsResult	For Steam identifiers which have not been linked to PlayFab accounts, null will be returned.
SteamPlayFabIdPair

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

GetPlayFabIDsFromSteamIDsRequest

Name	Type	Description
SteamStringIDs	string[]	Array of unique Steam identifiers (Steam profile IDs) for which the title needs to get PlayFab identifiers. The array cannot exceed 2,000 in length.

GetPlayFabIDsFromSteamIDsResult

For Steam identifiers which have not been linked to PlayFab accounts, null will be returned.

Name	Type	Description
Data	SteamPlayFabIdPair[]	Mapping of Steam identifiers to PlayFab identifiers.

SteamPlayFabIdPair

Name	Type	Description
PlayFabId	string	Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Steam identifier.
SteamStringId	string	Unique Steam identifier for a user.