Skip to main content

​
GET (/handles/)

Retrieves handles specified by handle ID.
Important:
This method is used by the 2015 Multiplayer and applies only to that multiplayer version and later. It is intended for use with template contract 104/105 or later, and requires a header element of X-Xbl-Contract-Version: 104/105 or later on every request.

​
Remarks

This HTTP/REST method gets the users’ current activity for the session, for the specified handles. The return is the session object, with all its attributes. This method can be wrapped by Microsoft.Xbox.Services.Multiplayer.MultiplayerService.GetCurrentSessionByHandleAsync. The caller of this method obtains the handle ID from a player’s MultiplayerActivityDetails object. Alternatively, the caller gets the ID from a protocol activation after a user has accepted a game invite.

​
URI parameters

| Parameter| Type| Description| | --- | --- | --- | --- | | handleId| GUID| The unique ID of the handle for the session.|

​
HTTP status codes

The service returns an HTTP status code as it applies to MPSD.

​
Request body

No objects are sent in the body of this request.

​
Response body

See the response structure in MultiplayerSession (JSON).

​
See also

Parent
/handles/
Last modified on August 4, 2026

Related topics

XblMultiplayerSearchHandleGetIdXblMultiplayerGetSessionByHandleAsyncXblMultiplayerGetSearchHandlesAsyncXblMultiplayerSessionHandleIdEntity Handles