Skip to main content

GET (/users/xuid())

Discover the presence of another user or client. The domain for these URIs is userpresence.xboxlive.com.

Remarks

The response can be filtered to provide part of the PresenceRecord if the consumer is not interested in the entire object.
Note:
The data returned is constrained by privacy and content isolation rules.

URI parameters

| Parameter| Type| Description| | --- | --- | --- | --- | | xuid| 64-bit unsigned integer| XBOX User ID (XUID) of the target user.|

Query string parameters

| Parameter| Type| Description| | --- | --- | --- | --- | --- | --- | --- | | level| string| Optional.
  • user: Returns only the user node.
  • device: Returns user node and device nodes.
  • title: Default. Returns the whole tree except activity.
  • all: Returns the whole tree, including activity-level presence.
|

Authorization

| Type| Required| Description| Response if missing| | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | | XUID| Yes| XBOX User ID (XUID) of the caller| 403 Forbidden|

Effect of privacy settings on resource

This method always returns 200 OK, but might not return content in the response body. | Requesting User| Target User’s Privacy Setting| Behavior| | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | | me| -| 200 OK| | friend| everyone| 200 OK| | friend| friends only| 200 OK| | friend| blocked| 200 OK| | non-friend user| everyone| 200 OK| | non-friend user| friends only| 200 OK| | non-friend user| blocked| 200 OK| | third-party site| everyone| 200 OK| | third-party site| friends only| 200 OK| | third-party site| blocked| 200 OK|

Required Request Headers

| Header| Type| Description| | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | | Authorization| string| Authentication credentials for HTTP authentication. Example value: “XBL3.0 x=<userhash>;<token>”.| | x-xbl-contract-version| string| 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, and so on. Example values: 3, vnext.| | Accept| string| Content-Types that are acceptable. The only one supported by Presence is application/json, but it must be specified in the header.| | Accept-Language| string| Acceptable locale for strings in the response. Example values: en-US.| | Host| string| Domain name of the server. Example value: presencebeta.xboxlive.com.|

Optional Request Headers

| Header| Type| 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, and so on. Default value: 1.|

Request body

No objects are sent in the body of this request.

Response body

Sample response

If there is no existing record for the user, a record with no devices is returned.

See also

Parent
/users/xuid()
Last modified on August 20, 2026