Integrate Xbox services easily.
We provide you all the tools you need to get started.
We provide you all the tools you need to get started.
API reference for retrieving account information and seeing all possible account types and subtypes
| Endpoints | |
|---|---|
| /account | Get account information |
| /account/{xuids} | Get account information for specified users |
| /search/{gamertag} | Find other players by gamertag |
| /alerts | Get user notifications |
| /generate/gamertag | Generate random gamertags |
/accountThe account endpoint makes a request to the profile service for gamer pic, gamerscore, gamertag, account tier, Xbox One rep, preferred color, real name, bio, and location.
Response fields and example.
object
Accounts object.
string
The Xbox User ID (XUID) is a unique identifier for the user.
string
This value is the same as the Xbox User ID (XUID).
object
Array of key-value pairs for requested information.
string
The key identifier for the supplied value.
string
The value for the specified key identifier.
boolean
Guest Users, also known as Sponsored Guests or Guest Accounts, allow players to interact with many Xbox Live services without needing to create a full Xbox Live account.
/account/{xuids}The account endpoint makes a request to the people hub service for gamer pic, gamerscore, gamertag, account tier, Xbox One rep, preferred color, real name, bio, and location.
Response fields and example.
object
People object.
string
The Xbox User ID (XUID) is a unique identifier for the user.
boolean
Determines if this user is a favorite of the request caller.
boolean
Determines if this user is following the request caller.
boolean
Determines if this user is followed by the request caller.
boolean
Determines if this user has shared their identity.
timestamp
Gets the timestamp, if set, of when the user was added.
string
The custom display name set by the user.
string
Provides the real name for the owner of the account.
string
Provides the gamer pic URL.
string
Identifier to determine if this user elected to show as their Avatar.
string
The unique gamertag set for this user and compatible with Xbox 360.
string
The total gamer score earned by this user.
string
The gamertag set for this user using the new Xbox One configuration.
string
The gamertag suffix set for this user using the new Xbox One configuration.
string
The combined modern gamertag and suffix which represents the unique gamertag for the user.
string
Returns the Xbox One reputation score for this user.
string
Provides the current state of the user; i.e. 'Online'
string
Provides the current activity of the user; i.e. 'Playing Halo Infinite'
null
Returns the list of devices the user is on.
boolean
Determines if the user is streaming live.
boolean
boolean
boolean
timestamp
Provides the datetime of when the user was last seen.
null
null
null
null
null
null
null
object
Returns the primary, secondary and tertiary color set by the user.
string
string
string
null
null
null
null
null
null
null
null
array
string
string
array
null
null
/search/{gamertag}This endpoint uses the people hub service to return 15 results for user detail, preferred color via gamertag.
Response fields and example.
object
People object.
string
The Xbox User ID (XUID) is a unique identifier for the user.
boolean
Determines if this user is a favorite of the request caller.
boolean
Determines if this user is following the request caller.
boolean
Determines if this user is followed by the request caller.
boolean
Determines if this user has shared their identity.
timestamp
Gets the timestamp, if set, of when the user was added.
string
The custom display name set by the user.
string
Provides the real name for the owner of the account.
string
Provides the gamer pic URL.
boolean
Identifier to determine if this user elected to show as their Avatar.
string
The unique gamertag set for this user and compatible with Xbox 360.
timestamp
The total gamer score earned by this user.
timestamp
The gamertag set for this user using the new Xbox One configuration.
timestamp
The gamertag suffix set for this user using the new Xbox One configuration.
timestamp
The combined modern gamertag and suffix which represents the unique gamertag for the user.
string
Returns the Xbox One reputation score for this user.
string
Provides the current state of the user; i.e. 'Online'
string
Provides the current activity of the user; i.e. 'Playing Halo Infinite'
null
Returns the list of devices the user is on.
boolean
Determines if the user is streaming live.
boolean
boolean
boolean
timestamp
Provides the datetime of when the user was last seen.
null
null
object
string
array
null
null
null
null
object
Returns the primary, secondary and tertiary color set by the user.
string
string
string
null
null
null
null
object
string
string
boolean
string
string
array
boolean
false
integer
integer
boolean
Determines if this user has an active Game Pass subscription.
null
null
string
object
string
string
object
null
null
Response fields and example.
objects
string
string
string
string
string
string
string
string
string
timestamp
boolean
string
string
/generate/gamertagThis endpoint uses the user management service to generate random gamertags that are available.
Request fields and example.
Response fields and example.
array