Skip to main content
Call this endpoint at the start of a game session to get the current configuration for the games your player can access. The response includes ad settings, reward configuration, version requirements, and maintenance status for each active game. Use the optional bundle_id parameter to retrieve settings for your specific game without loading the full catalog.

Endpoint

No authentication is required.

Query parameters

string
Filter the response to a single game by its Android package name or iOS bundle identifier (e.g. com.example.mygame). When omitted, all active games are returned.

Example requests

Without filtering — returns all active games:
With bundle_id — returns only the matching game:

Response

200 OK

The response data field is an array of game objects.
number
A stable numeric identifier derived from the game’s database ID. Safe to use as a local key across sessions.
string
The game’s display name.
string
The Android package name or iOS bundle identifier (e.g. com.example.mygame).
string
The Google Play Store URL for the game.
string | null
URL for the game’s artwork image. null if no thumbnail has been configured.
string
The game’s play mode. One of: level_based, endless, hybrid.
boolean
Whether coin rewards are active for this game. When false, do not award or display coin rewards regardless of game events.
boolean
Whether ads are enabled for this game. Check this alongside the global ads_enabled flag from /v1/app-settings.
string
The iOS App Store identifier for this game.
string
The current version string for this game (e.g. "1.4.2").
boolean
If true, this game is unavailable. Show a maintenance UI and prevent the player from starting a session. This is true when either the game itself or the global app is in maintenance mode.
number
The minimum supported version code for this game. Prompt the player to update if their installed version code is below this value.
number
Show a post-game interstitial ad after every N completed games for this specific game. Overrides the global setting from /v1/app-settings.