Games
games.list
Returns every game for your account and environment.
Who calls it
You → us
POST /v1/games.listYour server pulls the list. It maps each game to its own lobby images, or uses ours as they are. Sign the call with your API key. See Authentication.
Request
An empty body: {}. No fields.
Answer
| Field | Type | What it is |
|---|---|---|
gameId | string | Map it to your own lobby entry. You send it in session.start. It never changes. |
name | string | The game’s name. Show it if you use our games as they are. |
enabled | boolean | false when the game is turned off in the back office. Take it out of your lobby. |
images | array | Our logo, one entry per size: size and url. |
parameters | object | The values you set for this game in our back office. Build your client from them. |
- The list is always complete. You may call it once a minute.
- A game turned off stops new rounds. A player with an open Mines round can still start a session to finish that round.
- Parameters are set in the back office only. The parameter
autoplayturns autoplay on or off. Some markets forbid autoplay.
Errors
This call returns no call-specific error codes.
Every call can return the codes that guard all calls. See Error codes.
Example
Request
{}
Answer
{
"ok": true,
"result": { "games": [
{ "gameId": "mines", "name": "Mines", "enabled": true,
"images": [ { "size": "400x400", "url": "https://cdn.nartifacts.com/mines/400.png" } ],
"parameters": { "autoplay": false } }
] },
"traceId": "tr-01JC…"
}