GitHubX

Game Sessions

Get all game sessions of an app

get

Retrieve all game sessions for the authenticated app

Authorizations
x-app-api-keystringRequired

App API key in format:

Responses
200

Game sessions retrieved successfully

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

{
  "gameSessions": [
    {
      "id": "text",
      "name": "text",
      "description": "text",
      "status": "ACTIVE",
      "startTime": "2025-11-29T08:28:25.751Z",
      "endTime": "2025-11-29T08:28:25.751Z",
      "createdAt": "2025-11-29T08:28:25.751Z",
      "updatedAt": "2025-11-29T08:28:25.751Z",
      "miniGameType": {
        "id": "text",
        "name": "text",
        "description": "text",
        "imageUrl": "text",
        "createdAt": "2025-11-29T08:28:25.751Z"
      },
      "playerCount": 0
    }
  ]
}

Create a new game session

post

Create a new game session for the authenticated app. Optionally specify a mini game type name or ID to associate with the game session. Cannot be both name and id.

Authorizations
x-app-api-keystringRequired

App API key in format:

Body
namestring | nullableOptional

Game session name

descriptionstring | nullableOptional

Game session description

statusstring · enumOptional

Game session status

Default: ACTIVEPossible values:
miniGameTypeIdstring | nullableOptional

Optional mini game type ID to associate with this game session.

miniGameTypeNamestring | nullableOptional

Optional mini game type name to associate with this game session.

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

{
  "name": "text",
  "description": "text",
  "status": "ACTIVE",
  "miniGameTypeId": "text",
  "miniGameTypeName": "text"
}
{
  "id": "text",
  "name": "text",
  "description": "text",
  "status": "ACTIVE",
  "startTime": "2025-11-29T08:28:25.751Z",
  "endTime": "2025-11-29T08:28:25.751Z",
  "createdAt": "2025-11-29T08:28:25.751Z",
  "updatedAt": "2025-11-29T08:28:25.751Z",
  "miniGameType": {
    "id": "text",
    "name": "text",
    "description": "text",
    "imageUrl": "text",
    "createdAt": "2025-11-29T08:28:25.751Z"
  },
  "playerCount": 0
}

Get a game session by ID

get

Retrieve a specific game session by its ID

Authorizations
x-app-api-keystringRequired

App API key in format:

Path parameters
sessionIdstringRequired

Game session ID

Responses
200

Game session retrieved successfully

application/json
get
/apps/game-sessions/{sessionId}
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-11-29T08:28:25.751Z",
  "endTime": "2025-11-29T08:28:25.751Z",
  "createdAt": "2025-11-29T08:28:25.751Z",
  "updatedAt": "2025-11-29T08:28:25.751Z",
  "miniGameType": {
    "id": "text",
    "name": "text",
    "description": "text",
    "imageUrl": "text",
    "createdAt": "2025-11-29T08:28:25.751Z"
  },
  "playerCount": 0
}

Get all players in a game session

get

Retrieve all players registered to a specific game session

Authorizations
x-app-api-keystringRequired

App API key in format:

Path parameters
sessionIdstringRequired

Game session ID

Responses
200

Game session players retrieved successfully

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

{
  "players": [
    {
      "score": 1,
      "createdAt": "2025-11-29T08:28:25.751Z",
      "updatedAt": "2025-11-29T08:28:25.751Z",
      "playerId": "text",
      "displayName": "text",
      "imageUrl": "text",
      "user": {
        "id": "text",
        "username": "text"
      }
    }
  ]
}

Register a player to a game session

post

Register an existing player to a specific game session

Authorizations
x-app-api-keystringRequired

App API key in format:

Path parameters
sessionIdstringRequired

Game session ID

Body
playerIdstringRequired

Player ID to register

Responses
post
/apps/game-sessions/{sessionId}/players
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"
}
{
  "score": 1,
  "createdAt": "2025-11-29T08:28:25.751Z",
  "updatedAt": "2025-11-29T08:28:25.751Z",
  "playerId": "text",
  "displayName": "text",
  "imageUrl": "text",
  "user": {
    "id": "text",
    "username": "text"
  }
}

Update a player's score in a game session

patch

Update the score of a specific player in a game session

Authorizations
x-app-api-keystringRequired

App API key in format:

Path parameters
sessionIdstringRequired

Game session ID

playerIdstringRequired

Player ID

Body
scorenumberRequired

Player score

Responses
200

Player score updated successfully

application/json
patch
/apps/game-sessions/{sessionId}/players/{playerId}
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
}
{
  "score": 1,
  "createdAt": "2025-11-29T08:28:25.751Z",
  "updatedAt": "2025-11-29T08:28:25.751Z",
  "playerId": "text",
  "displayName": "text",
  "imageUrl": "text",
  "user": {
    "id": "text",
    "username": "text"
  }
}
PreviousPlayersNextMini Game Types

Last updated