Skip to main content
GET
/
game-configs
/
{id}
Get game config by ID
curl --request GET \
  --url https://{subdomain}.nudj.cx/api/v2/admin/game-configs/{id} \
  --header 'x-api-token: <api-key>'
{
  "id": "<string>",
  "organisationId": "<string>",
  "details": {
    "title": "<string>",
    "description": "<string>",
    "light": {
      "primaryImageUrl": "<string>",
      "secondaryImageUrl": "<string>"
    },
    "dark": {
      "primaryImageUrl": "<string>",
      "secondaryImageUrl": "<string>"
    }
  },
  "gameType": "memory",
  "gameConfig": {},
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

Authorizations

​
x-api-token
string
header
required

Headers

​
x-language
string

The language to return the game config in. If not provided, the default organisation language is used.

Path Parameters

​
id
string
required

The ID of the game config

Response

Successful response

A Nudj game configuration

​
id
string
required

The id of the game configuration

​
organisationId
string
required

The organisation that the game configuration belongs to

​
details
Details · object
required

The details of this game configuration such as title and description

​
gameType
enum<string>
required

The type of game

Available options:
memory,
catch
​
gameConfig
object
required

Raw JSON game configuration

​
createdAt
string
required

The date when this game configuration was created

​
updatedAt
string

The date when this game configuration was last updated