Account Management - Get PlayFab IDs From Steam Names

Service:

Client

API Version:

250704

Retrieves the unique PlayFab identifiers for the given set of Steam identifiers. The Steam identifiers are persona names.

POST https://titleId.playfabapi.com/Client/GetPlayFabIDsFromSteamNames

Request Header

Name	Required	Type	Description
X-Authorization	True	string	This API requires a client session ticket, available from any Client Login function.

Request Body

Name	Required	Type	Description
SteamNames	True	string[]	Array of unique Steam identifiers for which the title needs to get PlayFab identifiers. The array cannot exceed 2,000 in length.

Responses

Name	Type	Description
200 OK	GetPlayFabIDsFromSteamNamesResult	For Steam identifiers which have not been linked to PlayFab accounts, or if the user has not logged in recently, null will be returned.
400 Bad Request	ApiErrorWrapper	This is the outer wrapper for all responses with errors

Security

X-Authorization

This API requires a client session ticket, available from any Client Login function.

Type: apiKey
In: header

Definitions

Name	Description
ApiErrorWrapper	The basic wrapper around every failed API response
GetPlayFabIDsFromSteamNamesRequest
GetPlayFabIDsFromSteamNamesResult	For Steam identifiers which have not been linked to PlayFab accounts, or if the user has not logged in recently, null will be returned.
SteamNamePlayFabIdPair

ApiErrorWrapper

Object

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

GetPlayFabIDsFromSteamNamesRequest

Object

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

GetPlayFabIDsFromSteamNamesResult

Object

For Steam identifiers which have not been linked to PlayFab accounts, or if the user has not logged in recently, null will be returned.

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

SteamNamePlayFabIdPair

Object

Name	Type	Description
PlayFabId	string	Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Steam identifier.
SteamName	string	Unique Steam identifier for a user, also known as Steam persona name.