GitHubX

Authentication

Get current user profile

get

Get the profile information for the authenticated user

Authorizations
Responses
200

User profile retrieved successfully

application/json
get
GET /api/v1/user HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": "text",
  "email": "text",
  "firstName": "text",
  "lastName": "text",
  "phoneNumber": "text",
  "username": "text",
  "createdAt": "2025-10-09T12:40:54.712Z"
}

Generate authentication game code

post

Generate a new 6-digit authentication code from headset side

Authorizations
Body
codestringRequired

Authentication code

Pattern: ^[0-9]{6}$
playerIdstring | nullableRequired

Player ID to associate with the code. Used to link the player to the code. Optional.

Responses
200

Code generated successfully

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

{
  "code": "text",
  "playerId": "text"
}
{
  "code": "text",
  "playerId": "text",
  "expiryTime": "2025-10-09T12:40:54.712Z"
}

Validate authentication code

post

Validate an authentication code and optionally return a session token

Authorizations
Body
codestringRequired

Authentication code

Pattern: ^[0-9]{6}$
Responses
200

Game code validation result

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

{
  "code": "text"
}
{
  "status": "VALID",
  "sessionToken": "text",
  "expiryTime": "2025-10-09T12:40:54.712Z",
  "error": "text"
}
PreviousCoreNextApps