GitHubX

Players

Get all players

get

Retrieve all players for the authenticated app

Authorizations
Responses
200

Players retrieved successfully

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

{
  "players": [
    {
      "id": "text",
      "displayName": "text",
      "userId": "text",
      "createdAt": "2025-10-09T18:06:11.330Z",
      "updatedAt": "2025-10-09T18:06:11.330Z"
    }
  ]
}

Create a new player

post

Create a new player for the authenticated app. Players with duplicate names are not allowed for the same app.

Authorizations
Body
userIdstring | nullableOptional

Optional user ID

displayNamestringRequired

Player display name

Responses
201

Player created successfully

application/json
post
POST /api/v1/players HTTP/1.1
Host: 
x-app-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "userId": "text",
  "displayName": "text"
}
{
  "id": "text",
  "displayName": "text",
  "userId": "text",
  "createdAt": "2025-10-09T18:06:11.330Z",
  "updatedAt": "2025-10-09T18:06:11.330Z"
}

Get a player by ID

get

Retrieve a specific player by their ID

Authorizations
Path parameters
idstringRequired

Player ID

Responses
200

Player retrieved successfully

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

{
  "id": "text",
  "displayName": "text",
  "userId": "text",
  "createdAt": "2025-10-09T18:06:11.330Z",
  "updatedAt": "2025-10-09T18:06:11.330Z"
}
PreviousAppsNextGame Sessions