Players
Retrieve all players for the authenticated app
App API key in format:
Players retrieved successfully
Unauthorized - invalid or missing API key
Internal server error
GET /api/v1/apps/players HTTP/1.1
Host:
x-app-api-key: YOUR_API_KEY
Accept: */*
{
"players": [
{
"id": "text",
"displayName": "text",
"userId": "text",
"imageUrl": "text",
"createdAt": "2025-11-28T21:00:37.741Z",
"updatedAt": "2025-11-28T21:00:37.741Z"
}
]
}Create a new player for the authenticated app. Players with duplicate names are not allowed for the same app.
App API key in format:
Optional user ID
Player display name
Player created successfully
Invalid request data
Unauthorized - invalid or missing API key
Internal server error
POST /api/v1/apps/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",
"imageUrl": "text",
"createdAt": "2025-11-28T21:00:37.741Z",
"updatedAt": "2025-11-28T21:00:37.741Z"
}Remove the profile image for a player
App API key in format:
Player ID
Profile image deleted successfully
Unauthorized - invalid or missing API key
Player not found
Internal server error
DELETE /api/v1/apps/players/{id}/profile-image HTTP/1.1
Host:
x-app-api-key: YOUR_API_KEY
Accept: */*
{
"success": true
}Upload or update a player's profile image. The image must meet specific requirements:
Minimum dimensions: 512x512 pixels
Maximum dimensions: 1024x1024 pixels (larger images will be automatically resized)
Maximum file size: 5MB
Supported formats: JPEG, PNG, GIF, WebP
Square aspect ratio recommended for best results
App API key in format:
Player ID
Profile image file
Profile image updated successfully
Invalid request
Unauthorized - invalid or missing API key
Player not found
Internal server error
PATCH /api/v1/apps/players/{id}/profile-image HTTP/1.1
Host:
x-app-api-key: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 18
{
"image": "binary"
}{
"imageUrl": "text"
}Retrieve a specific player by their ID. Optionally include global rankings across all mini-game types.
App API key in format:
Player ID
If true, includes the player's global rankings for all mini-game types they have participated in
falsePlayer retrieved successfully
Unauthorized - invalid or missing API key
Player not found
Internal server error
GET /api/v1/apps/players/{id} HTTP/1.1
Host:
x-app-api-key: YOUR_API_KEY
Accept: */*
{
"id": "text",
"displayName": "text",
"userId": "text",
"imageUrl": "text",
"createdAt": "2025-11-28T21:00:37.741Z",
"updatedAt": "2025-11-28T21:00:37.741Z"
}Update a player's information (display name and user association)
App API key in format:
Player ID
Optional user ID
Player display name
Player updated successfully
Invalid request data
Unauthorized - invalid or missing API key
Forbidden - can only update players belonging to your app
Player not found
Internal server error
PATCH /api/v1/apps/players/{id} 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",
"imageUrl": "text",
"createdAt": "2025-11-28T21:00:37.741Z",
"updatedAt": "2025-11-28T21:00:37.741Z"
}Get a player's global ranking across all default games or all games for a specific mini game type
App API key in format:
Player ID
Optional mini game type ID to get ranking for a specific game type. If not provided, the ranking for all default games will be returned.
Optional mini game type name to get ranking for a specific game type. If not provided, the ranking for all default games will be returned.
Player ranking retrieved successfully
Unauthorized - invalid or missing API key
Player not found or has no ranking
Internal server error
GET /api/v1/apps/players/{playerId}/global-ranking HTTP/1.1
Host:
x-app-api-key: YOUR_API_KEY
Accept: */*
{
"highestScore": 1,
"ranking": 1,
"miniGameTypeId": "text",
"miniGameTypeName": "text"
}Last updated