Skip to main content

User API

The User API provides endpoints for retrieving player information from external games.

Overview

The User API enables you to:

  • Get Authenticated User Info: Retrieve the currently authenticated user's profile, roles, and organizations from a game client
  • Get Player Info by ID: Look up any player's public profile and wallets from your game server

Endpoints

MethodEndpointAuthDescription
GET/api/v2/user/gameGame Client Key + JWTGet authenticated user's info
GET/api/v2/user/{userId}/gameGame Server KeyGet player info by user ID

Authentication

These endpoints use different authentication methods depending on the caller:

Game Client (user-facing)

Requires both the game client key and the user's JWT token:

x-game-key: your-game-client-key
Authorization: Bearer user-jwt-token

Game Server (server-to-server)

Requires only the game server key (no user token needed):

x-game-server-key: your-game-server-key

Next Steps