Account Management - Get Title Players From Master Player Account Ids
Retrieves the title player accounts associated with the given master player account.
POST https://titleId.playfabapi.com/Profile/GetTitlePlayersFromMasterPlayerAccountIdsRequest Header
| Name | Required | Type | Description |
|---|---|---|---|
| X-EntityToken | True |
string |
This API requires an Entity Session Token, available from the Entity GetEntityToken method. |
Request Body
| Name | Required | Type | Description |
|---|---|---|---|
| MasterPlayerAccountIds | True |
string[] |
Master player account ids. |
| CustomTags |
object |
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). |
|
| TitleId |
string |
Id of title to get players from. |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK | ||
| 400 Bad Request |
This is the outer wrapper for all responses with errors |
Security
X-EntityToken
This API requires an Entity Session Token, available from the Entity GetEntityToken method.
Type:
apiKey
In:
header
Definitions
| Name | Description |
|---|---|
|
Api |
The basic wrapper around every failed API response |
|
Entity |
Combined entity type and ID structure which uniquely identifies a single entity. |
|
Get |
Given a master player account id (PlayFab ID), returns all title player accounts associated with it. |
|
Get |
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 |
EntityKey
Combined entity type and ID structure which uniquely identifies a single entity.
| Name | Type | Description |
|---|---|---|
| Id |
string |
Unique ID of the entity. |
| Type |
string |
Entity type. See https://docs.microsoft.com/gaming/playfab/features/data/entities/available-built-in-entity-types |
GetTitlePlayersFromMasterPlayerAccountIdsRequest
Given a master player account id (PlayFab ID), returns all title player accounts associated with it.
| Name | Type | Description |
|---|---|---|
| CustomTags |
object |
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). |
| MasterPlayerAccountIds |
string[] |
Master player account ids. |
| TitleId |
string |
Id of title to get players from. |
GetTitlePlayersFromMasterPlayerAccountIdsResponse
| Name | Type | Description |
|---|---|---|
| TitleId |
string |
Optional id of title to get players from, required if calling using a master_player_account. |
| TitlePlayerAccounts |
Dictionary of master player ids mapped to title player entity keys and id pairs |