GET (/users//people/)

Gets a person by target ID from caller’s people collection. The domain for these URIs is social.xboxlive.com.

Remarks
URI parameters
Authorization
Required Request Headers
Optional Request Headers
Request body
HTTP status codes
Required Response Headers
Response body

Remarks

GET operations won’t modify any resources so this will produce the same results if executed once or multiple times.

URI parameters

Parameter	Type	Description
ownerId	string	Identifier of the user whose resource is being accessed. Must match the authenticated user. The possible values are “me”, xuid(), or gt().
targetid	string	Identifier of the user whose data is being retrieved from the owner’s People list, either an XBOX User ID (XUID) or a gamertag. Example values: xuid(2603643534573581), gt(SomeGamertag).

Authorization

| Type| Required| Description| Response if missing| | --- | --- | --- | --- | --- | --- | --- | | XUID| yes| Caller has user’s XBOX User ID (XUID).| 401 Unauthorized|

Required Request Headers

| Header| Description| | --- | --- | --- | --- | --- | --- | --- | --- | --- | | Authorization| String. Authorization data for XBOX LIVE. This is typically an encrypted XSTS token. Example value: XBL3.0 x=<userhash>;<token>.|

Optional Request Headers

| Header| Description| | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | | X-RequestedServiceVersion| Build name/number of the XBOX LIVE service to which this request should be directed. The request will only be routed to that service after verifying the validity of the header, the claims in the auth token, etc. Default value: 1.| | Accept| String. Content-Types that the caller accepts in the response. All responses are application/json.|

Request body

No objects are sent in the body of this request.

HTTP status codes

The service returns one of the status codes in this section in response to a request made with this method on this resource. For a complete list of standard HTTP status codes used with XBOX Live Services, see Standard HTTP status codes. | Code| Reason phrase| Description| | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | | 200| OK| Success.| | 400| Bad Request| User IDs were malformed.| | 403| Forbidden| XUID claim could not be parsed from the authorization header.| | 404| Not Found| Target user was not found in the owner’s People list.|

Required Response Headers

| Header| Type| Description| | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | | Content-Length| 32-bit unsigned integer| Length, in bytes, of the response body. Example value: 22.| | Content-Type| string| MIME type of the response body. This will always be application/json.|

Response body

If the call is successful, the service returns the target person. See Person (JSON).

Sample response

{
    "xuid": "2603643534573581",
    "isFavorite": false,
    "isFollowingCaller": false,
    "socialNetworks": ["LegacyXboxLive"]
}
         

(all) API references

Error codes

Audio API reference

Chat API reference

Developer kit only API reference

Graphics API reference

Input API reference

Lighting API reference

Networking API reference

XBOX PC remote iteration API reference

System API reference

Tools API reference

Windows device portal REST API reference

XBOX services API reference

MicrosoftGame.config reference

GET (/users/{ownerId}/people/{targetid})

GET (/users//people/)

Remarks

URI parameters

Authorization

Required Request Headers

Optional Request Headers

Request body

HTTP status codes

Required Response Headers

Response body

Sample response

See also

Parent

​GET (/users//people/)

​Remarks

​URI parameters

​Authorization

​Required Request Headers

​Optional Request Headers

​Request body

​HTTP status codes

​Required Response Headers

​Response body

​Sample response

​See also

Parent

GET (/users//people/)

Remarks

URI parameters

Authorization

Required Request Headers

Optional Request Headers

Request body

HTTP status codes

Required Response Headers

Response body

Sample response

See also