Skip to content

Get Player Sessions By Uuid V2

GET
/session/v1/player/{player_uuid}/session

Get Sessions associated with a player by uuid

Required Permissions:

  • For any player (including themselves) any of: session:*, session:read-player:any

  • For the player themselves : session:read-player:self

Required Session Permissions: None

Authorizations

Parameters

Path Parameters

player_uuid
required
string format: uuid

Header Parameters

if-none-match

If you provide the ETag that matches the current ETag for this resource, a 304 response will be returned - indicating that the resource has not changed.

string

If you provide the ETag that matches the current ETag for this resource, a 304 response will be returned - indicating that the resource has not changed.

Responses

200

Successful Response

Information about all sessions that a player is currently a member of, or invited to

object
sessions

Session associated with this player, and any pending invites

object
key
additional properties

Information about the sessions of a specific type that a player is currently a member of, or invited to

object
type
required

Template type

string
session_ids

Sessions the player is currently a part of for this session type, if any.

Array<string>
default: unique items
pending_invites

Pending invites, if any, for the current player in this session type

object
key
additional properties

Information about an invite to a session that a player received

object
session_id
required

Session ID for the invite

string
>= 1 characters <= 128 characters
inviting_player_uuid

Player who sent the invite

string format: uuid
reserved_sessions

Sessions that the player has a reserved place in, but has not yet been invited

Array<string>
default: unique items
last_updated_timestamp

Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone

string format: date-time

Headers

ETag
string

Used to identify this version of the content. Provide with a get request to avoid downloading the same data multiple times.

403

Forbidden

object
auth_success
boolean
default: true
error_code
required
string
desc
required
string

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string