/serviceconfigs/{scid}/sessiontemplates/{sessionTemplateName}/sessions - XBOX Game Development Documentation

Supports a GET operation to retrieve a set of session templates with the specified template names.

Domain

sessiondirectory.xboxlive.com

URI parameters

Parameter	Type	Description
scid	GUID	Service configuration identifier (SCID). Part 1 of the session ID.
keyword	string	A keyword used to filter results to just sessions identified with that string.
xuid	GUID	XBOX user IDs for the users for whom to retrieve sessions. The users must be active in the sessions.
reservations	string	Value indicating if the list of sessions includes those that the users have not accepted. This parameter can only be set to true. This setting requires the caller to have server-level access to the session, or the caller’s XUID claim to match the XBOX user ID filter.
inactive	string	Value indicating if the list of sessions includes those that the users have accepted but are not actively playing. This parameter can only be set to true.
private	string	Value indicating if the list of sessions includes private sessions. This parameter can only be set to true. It is valid only when querying your own sessions, or when querying server-to-server. Setting this parameter to true requires the caller to have server-level access to the session, or the caller’s XUID claim to match the XBOX user ID filter.
visibility	string	An enumeration value indicating visibility status used in filtering results. Currently this parameter can only be set to Open to include open sessions. See MultiplayerSessionVisibility.
version	string	A positive integer indicating the major session version or lower of the sessions to include. The value must be less than or equal to the request’s contract version modulo 100.
take	string	A positive integer indicating the maximum number of sessions to retrieve.

Valid methods

GET (/serviceconfigs//sessiontemplates//sessions) Retrieves session template documents.

See also

Parent

Session Directory URIs

Last modified on October 29, 2026

⌘I