Skip to main content
GET
/
game-configs
Get paginated game configs
curl --request GET \
  --url https://{subdomain}.nudj.cx/api/v2/admin/game-configs \
  --header 'x-api-token: <api-key>'
{
  "totalCount": 123,
  "edges": [
    {
      "id": "<string>",
      "organisationId": "<string>",
      "details": {
        "title": "<string>",
        "description": "<string>",
        "light": {
          "primaryImageUrl": "<string>",
          "secondaryImageUrl": "<string>"
        },
        "dark": {
          "primaryImageUrl": "<string>",
          "secondaryImageUrl": "<string>"
        }
      },
      "gameType": "catch",
      "config": {
        "clientBranding": {
          "gameTitle": "<string>",
          "gameDescription": "<string>",
          "clientName": "<string>",
          "clientWebsite": "<string>",
          "background": {
            "image": "<string>",
            "color": "<string>"
          },
          "logo": {
            "url": "<string>",
            "alt": "<string>"
          },
          "favicon": "<string>",
          "font": "<string>",
          "colors": {
            "primary": "<string>",
            "on-primary": "<string>",
            "secondary": "<string>",
            "on-secondary": "<string>",
            "accent": "<string>",
            "on-accent": "<string>"
          },
          "style": {
            "cornerRadius": 123
          },
          "icons": {
            "play": "<string>",
            "pause": "<string>",
            "restart": "<string>",
            "home": "<string>",
            "volume": "<string>",
            "volume-off": "<string>",
            "level-completed": "<string>",
            "level-failed": "<string>",
            "game-completed": "<string>",
            "game-over": "<string>",
            "star": "<string>"
          }
        },
        "gameConfig": {
          "game": "<string>",
          "odds": 0.5,
          "scratchCardImage": "<string>",
          "backgroundImage": "<string>",
          "productImages": [
            {
              "id": "<string>",
              "url": "<string>",
              "alt": "<string>",
              "winning": true,
              "distributionEventId": "<string>"
            }
          ],
          "particlesColor": "<string>",
          "cardColor": "<string>",
          "cardGlowingColor": "<string>",
          "cardTextColor": "<string>",
          "sounds": {
            "win": "<string>",
            "lose": "<string>"
          }
        },
        "textContent": {
          "loading": {
            "title": "<string>",
            "subtitle": "<string>",
            "progressText": "<string>",
            "logoAlt": "<string>"
          },
          "home": {
            "startButton": "<string>",
            "loadingText": "<string>",
            "preparingText": "<string>",
            "features": [
              {
                "title": "<string>",
                "description": "<string>"
              }
            ]
          },
          "tutorial": {
            "title": "<string>",
            "subtitle": "<string>",
            "startButton": "<string>",
            "logoAlt": "<string>",
            "instructions": [
              {
                "icon": "<string>",
                "title": "<string>",
                "description": "<string>"
              }
            ]
          },
          "gameUI": {
            "soundToggle": {
              "enable": "<string>",
              "disable": "<string>"
            },
            "pauseToggle": {
              "pause": "<string>",
              "resume": "<string>"
            }
          },
          "modals": {
            "win": {
              "title": "<string>",
              "subtitle": "<string>",
              "homeButton": "<string>",
              "closeButton": "<string>"
            },
            "lose": {
              "title": "<string>",
              "subtitle": "<string>",
              "homeButton": "<string>",
              "closeButton": "<string>"
            }
          },
          "errors": {
            "configurationError": "<string>",
            "configurationErrorMessage": "<string>",
            "retryButton": "<string>",
            "imageLoadError": "<string>"
          },
          "accessibility": {
            "playButton": "<string>",
            "pauseButton": "<string>",
            "homeButton": "<string>",
            "progressIndicator": "<string>"
          },
          "status": {
            "gameStarted": "<string>",
            "win": "<string>",
            "lose": "<string>"
          }
        }
      },
      "createdAt": "<string>",
      "rewardDistributions": [
        {
          "points": 1,
          "xp": 1,
          "rewardSelectionMethod": "all",
          "distributionEventId": "<string>",
          "rewardAllocations": [
            {
              "rewardId": "<string>",
              "allocationId": "<string>",
              "allocationType": "assets",
              "amountToDistribute": 2
            }
          ],
          "numberOfRewardsToReceive": 1
        }
      ],
      "progressPeriod": "daily",
      "maxCompletionsPerPeriod": 1,
      "updatedAt": "<string>"
    }
  ]
}

Authorizations

x-api-token
string
header
required

Headers

x-language
string

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

Query Parameters

limit
integer
default:10
Required range: 1 <= x <= 100
skip
integer
default:0
Required range: x >= 0
gameType
enum<string>
Available options:
catch,
memory,
scratch

Response

Successful response

totalCount
number
required
edges
GameConfig · object[]
required