GitHubX

Game Sessions

Get all game sessions of an app

get

Retrieve all game sessions for the authenticated app

Authorizations
Responses
200

Game sessions retrieved successfully

application/json
get
GET /api/v1/apps/game-sessions HTTP/1.1
Host: 
x-app-api-key: YOUR_API_KEY
Accept: */*

[
  {
    "id": "text",
    "name": "text",
    "description": "text",
    "status": "ACTIVE",
    "startTime": "2025-10-09T19:32:48.051Z",
    "endTime": "2025-10-09T19:32:48.051Z",
    "createdAt": "2025-10-09T19:32:48.051Z",
    "updatedAt": "2025-10-09T19:32:48.051Z",
    "miniGameType": {
      "id": "text",
      "name": "text",
      "description": "text",
      "createdAt": "2025-10-09T19:32:48.051Z"
    },
    "score": 0
  }
]

Create a new game session

post

Create a new game session for the authenticated app

Authorizations
Body
namestring | nullableOptional

Game session name

descriptionstring | nullableOptional

Game session description

statusstring · enumOptional

Game session status

Default: ACTIVEPossible values:
miniGameTypeIdstring | nullableOptional

Mini game type ID

Responses
201

Game session created successfully

application/json
post
POST /api/v1/apps/game-sessions HTTP/1.1
Host: 
x-app-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 78

{
  "name": "text",
  "description": "text",
  "status": "ACTIVE",
  "miniGameTypeId": "text"
}
{
  "id": "text",
  "name": "text",
  "description": "text",
  "status": "ACTIVE",
  "startTime": "2025-10-09T19:32:48.051Z",
  "endTime": "2025-10-09T19:32:48.051Z",
  "createdAt": "2025-10-09T19:32:48.051Z",
  "updatedAt": "2025-10-09T19:32:48.051Z",
  "miniGameType": {
    "id": "text",
    "name": "text",
    "description": "text",
    "createdAt": "2025-10-09T19:32:48.051Z"
  },
  "score": 0
}

Get a game session by ID

get

Retrieve a specific game session by its ID

Authorizations
Path parameters
sessionIdstringRequired

Game session ID

Responses
200

Game session retrieved successfully

application/json
get
GET /api/v1/apps/game-sessions/{sessionId} HTTP/1.1
Host: 
x-app-api-key: YOUR_API_KEY
Accept: */*

{
  "id": "text",
  "name": "text",
  "description": "text",
  "status": "ACTIVE",
  "startTime": "2025-10-09T19:32:48.051Z",
  "endTime": "2025-10-09T19:32:48.051Z",
  "createdAt": "2025-10-09T19:32:48.051Z",
  "updatedAt": "2025-10-09T19:32:48.051Z",
  "miniGameType": {
    "id": "text",
    "name": "text",
    "description": "text",
    "createdAt": "2025-10-09T19:32:48.051Z"
  },
  "score": 0
}

Get all players in a game session

get

Retrieve all players registered to a specific game session

Authorizations
Path parameters
sessionIdstringRequired

Game session ID

Responses
200

Game session players retrieved successfully

application/json
get
GET /api/v1/apps/game-sessions/{sessionId}/players HTTP/1.1
Host: 
x-app-api-key: YOUR_API_KEY
Accept: */*

{
  "players": [
    {
      "id": "text",
      "score": 1,
      "createdAt": "2025-10-09T19:32:48.051Z",
      "updatedAt": "2025-10-09T19:32:48.051Z",
      "playerId": "text",
      "displayName": "text",
      "userId": "text",
      "playerCreatedAt": "2025-10-09T19:32:48.051Z",
      "playerUpdatedAt": "2025-10-09T19:32:48.051Z"
    }
  ]
}

Register a player to a game session

post

Register an existing player to a specific game session

Authorizations
Path parameters
sessionIdstringRequired

Game session ID

Body
playerIdstringRequired

Player ID to register

Responses
201

Player registered to game session successfully

application/json
post
POST /api/v1/apps/game-sessions/{sessionId}/players HTTP/1.1
Host: 
x-app-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "playerId": "text"
}
{
  "id": "text",
  "score": 1,
  "createdAt": "2025-10-09T19:32:48.051Z",
  "updatedAt": "2025-10-09T19:32:48.051Z",
  "playerId": "text",
  "displayName": "text",
  "userId": "text",
  "playerCreatedAt": "2025-10-09T19:32:48.051Z",
  "playerUpdatedAt": "2025-10-09T19:32:48.051Z"
}

Update a player's score in a game session

patch

Update the score of a specific player in a game session

Authorizations
Path parameters
sessionIdstringRequired

Game session ID

playerIdstringRequired

Player ID

Body
scorenumberRequired

Player score

Responses
200

Player score updated successfully

application/json
patch
PATCH /api/v1/apps/game-sessions/{sessionId}/players/{playerId} HTTP/1.1
Host: 
x-app-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 11

{
  "score": 1
}
{
  "id": "text",
  "score": 1,
  "createdAt": "2025-10-09T19:32:48.051Z",
  "updatedAt": "2025-10-09T19:32:48.051Z",
  "playerId": "text",
  "displayName": "text",
  "userId": "text",
  "playerCreatedAt": "2025-10-09T19:32:48.051Z",
  "playerUpdatedAt": "2025-10-09T19:32:48.051Z"
}
PreviousPlayersNextMini Game Types