GET (/users/{userId}/profile/settings/people/{userList})

Article
06/22/2023

Get the profile for a user or users, with People Moniker support. The domain for these URIs is profile.xboxlive.com.

Remarks
URI parameters
Query string parameters
Required Request Headers
Request body

Remarks

userList and userIds are mutually-exclusive parameters. If both or either are specified, you'll get a BadRequest back. userList is an array for future-proofing in scenarios where multiple named lists are useful to request. userIds is composed of decimal strings for XUIDs - JSON is bad at serializing 64-bit unsigned integers. Finally, settings in Xbox One will be named settings, with normal human-readable names, rather than 64-bit unsigned integers or obscure constants like XONLINE_PROFILE_ASDF.

URI parameters

Parameter	Type	Description
userId	string	Can be either 'xuid(12345)', 'gt(myGamertag)', or 'me'.
userList	string	A named list of people to get settings for. Currently, People is the only list supported.

Query string parameters

Parameter	Type	Description
settings	string	A comma-delimited list of setting names.

Required Request Headers

Header	Type	Description
x-xbl-contract-version	32-bit signed integer	Value = 2
content-type	string	Value = `application/json`

Request body

Sample request

GET /users/me/profile/settings/people/people?settings=GameDisplayName,GameDisplayPicRaw,Gamerscore,Gamertag

Response body

The response is a ReadMultiSettingsResponseV2 object. Assuming the calling user has only one friend:

{
      "profileUsers":[
         {
            "id":"2533274791381930",
            "settings":[
               {
                  "id":"GameDisplayName",
                  "value":"John Smith"
               },
               {
                  "id":"GameDisplayPicRaw",
                  "value":"http://images-eds.xboxlive.com/image?url=z951ykn43p4FqWbbFvR2Ec.8vbDhj8G2Xe7JngaTToBrrCmIEEXHC9UNrdJ6P7KIN0gxC2r1YECCd3mf2w1FDdmFCpSokJWa2z7xtVrlzOyVSc6pPRdWEXmYtpS2xE4F&format=png&w=64&h=64"
               },
               {
                  "id":"Gamerscore",
                  "value":"0"
               },
               {
                  "id":"Gamertag",
                  "value":"CracklierJewel9"
               }
            ]
         }
      ]
   }

Share via