Users
User Endpoints to query user information, search for users, purge users (for GDPR or other delete reasons), and update linking/cross-progresion status for users.
📄️ Get Player Uuid From Player Id For Self
Get a player's uuid from their id for the active player on the access token.
📄️ Get Player Uuid From Player Id
Get a player's uuid from their id.
📄️ Get Player Uuid From Player Id For Self V2
Get a player's uuid from their id for the active player on the access token.
📄️ Get Player Uuid From Player Id V2
Get a player's uuid from their id.
📄️ Get Player Id From Player Uuid For Self
Get a player's id from their uuid for the active player on the access token.
📄️ Get Player Id From Player Uuid
Get a player's id from their uuid.
📄️ Get Player Links For Self
Get a player's linked portals for the active player on the access token.
📄️ Get Player Links
Get a player's linked portals.
📄️ Get Player Linked Portals
**DEPRECATED** Please use `/v2/player/{player_uuid}/links` instead. Get a player's linked portals.
📄️ Find Platform User By Id
Find an existing platform user with their platform identity.
📄️ Update Platform User By Id
Update or create a platform user from a platform identity.
📄️ Create Platform User By Id
Create a new platform user from a platform identity.
📄️ Lookup Player By Portal
Lookup players by various parameters.
📄️ Get Players Paged
Iterate over all players. This is a paginated API, so you will need to call it multiple times to get all players.
📄️ Get Person For Self
Get information for the person on the access token.
📄️ Update Person For Self
Update information for the person on the access token.
📄️ Get Person
Get information for a person.
📄️ Update Person
Update the information for a person.
📄️ Get Person Email List For Self
Get the email list ids for a person on the access token
📄️ Update Person Email List For Self
Update the email list for person on the access token. This is used to control which emails a person receives.
📄️ Get Person Email List
Get the email list ids for a person
📄️ Update Person Email List
Update the email list for a person. This is used to control which emails a person receives.
📄️ Get Queue Purge Status For Me
Get the purge status for a person of the access token.
📄️ Queue Me For Purge
Queue person on the access token for purging. This can occur up to a configured amount of time in the future or can occur immediately depending on `suggested_purge_time`.
📄️ Dequeue Me For Purge
Dequeue the active person of the access token if they are queued to be purged. This will only work if the purge has not already begun.
📄️ Get Queue Purge Status For Person
Get the purge status for a person.
📄️ Queue Person For Purge
Queue a person for purging. This can occur up to a configured amount of time in the future or can occur immediately depending on `suggested_purge_time`.
📄️ Dequeue Person For Purge
Dequeue a Person that is queued to be purged. This will only work if the purge has not already begun.
📄️ Get Person Restrictions For Self
Get Restrictions for your person. These same restrictions apply to all players associated with the person
📄️ Get Person Restrictions
Get Restrictions for a person. These same restrictions apply to all players associated with the person
📄️ Add Person Restrictions
Add a new restriction to an existing person
📄️ Remove Person Restrictions
Remove restrictions from user. NOTE: this will NOT remove restrictions for account deletion
📄️ Get Player Restrictions For Self
Get Restrictions for a player
📄️ Get Player Restrictions
Get Restrictions for a player
📄️ Add Player Restrictions
Add a new restriction to an existing player's person
📄️ Remove Player Restrictions
Remove restrictions from user. NOTE: this will NOT remove restrictions for account deletion
📄️ Link
Link a follower platform user to a leader person.
📄️ Unlink
Unlink a platform user from their current person. This will create a new person for the
📄️ Enable Cross Progression
Enable Cross Progression for the player associated with the platform identity.
📄️ Disable Cross Progression
Disable Cross Progression for a person. While cross progression is disabled,
📄️ Get All Roles
Get all current roles. Including their custom_data and login_loot_rewards.
📄️ Get Login History
Get the Login history for a given user
📄️ Get Link History
Get the Link history for a given user