Sign in
session

Get party session details

Returns detailed information about a specific party session.

Parameters

  • sessionName - The unique session identifier (UUID format)

Response Details

The response includes:

  • Members - All current participants with their status
  • Properties - Session visibility and join restrictions
  • Host info - Who created the session
  • Activity - Current session activity state

Member Properties

Each member entry contains:

  • xuid - Xbox User ID
  • active - Whether they are currently active in the session
  • connection - Connection state information
get/v2/session/{sessionName}

Path parameters

sessionNamestring required

Response

Party session details

{"stackTrail":"components:schemas:ApiResponse:properties:content","oasType":"schema","type":"unknown","description":"The response payload from the upstream Xbox/Microsoft API. The structure varies by endpoint - can be an object, array, or string."}
codeinteger required

HTTP status code from the upstream API. Common values: 200 (success), 400 (bad request), 401 (unauthorized), 404 (not found), 410 (deprecated/gone), 429 (rate limited), 500 (server error)

Example response

{
  "code": 200
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.