GET (/users//summary)

Gets summary data about the owner from the caller’s perspective.

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

URI parameters

Parameter	Type	Description
ownerId	string	Identifier of the user whose resource is being accessed. The possible values are “me”, xuid(), or gt(). Example values: `me`, `xuid(2603643534573581)`, `gt(SomeGamertag)`

Authorization

| Name| Type| Description| | --- | --- | --- | --- | --- | --- | | xuid| 64-bit unsigned integer| Required. user identifier of the caller. Example value: 2533274790395904|

Required Request Headers

| Header| Type| Description| | --- | --- | --- | --- | --- | --- | --- | --- | --- | | Authorization| string| Authorization data for . This is typically an encrypted XSTS token. Example value: XBL3.0 x=[hash];[token].|

Optional Request Headers

| Header| Type| Description| | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | | x-xbl-contract-version| string| Build name/number of the 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. Example values: 1| | Accept| string| Content-Types that are acceptable. All responses will be 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| The session was successfully retrieved.| | 400| Bad Request| User IDs were malformed.| | 403| Forbidden| XUID claim could not be parsed from the authorization header.|

Required Response Headers

| Header| Type| Description| | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | | Content-Length| string| The number of bytes being sent in the response. Example value: 232.| | Content-Type| string| MIME type of the response body. This must be application/json.|

Response body

See PersonSummary (JSON).

Sample response

{
    "targetFollowingCount": 87,
    "targetFollowerCount": 19,
    "isCallerFollowingTarget": true,
    "isTargetFollowingCaller": false,
    "hasCallerMarkedTargetAsFavorite": true,
    "hasCallerMarkedTargetAsKnown": true,
    "legacyFriendStatus": "None",
    "recentChangeCount": 5,
    "watermark": "5246775845000319351"
}

(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}/summary)

GET (/users//summary)

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//summary)

​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//summary)

URI parameters

Authorization

Required Request Headers

Optional Request Headers

Request body

HTTP status codes

Required Response Headers

Response body

Sample response

See also