Games

Get Player Scores

get

Get a Player's score data for a specific Game.

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

game_idstringRequired

The game id to get scores for

Pattern: ^[a-zA-Z0-9_-]+$

player_idstringRequired

The player id to get scores for

Pattern: ^[a-zA-Z0-9_-]+$

include_game_objectsbooleanOptional

Whether to include game objects in the response

Default: false

Responses

200

Successful response

application/json

default

Error response

application/json

get

/games/getPlayerScores

HTTPcURLJavaScriptPython

GET /api/games/getPlayerScores?game_id=text&player_id=text HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "playerScores": [
    {
      "createdAt": "text",
      "updatedAt": "text",
      "score": 1,
      "playerId": "text",
      "gameObjectId": "text",
      "gameObject": {
        "id": "text",
        "createdAt": "text",
        "updatedAt": "text",
        "name": "text",
        "description": "text"
      }
    }
  ]
}

Get All Games

get

Get all Games. Paginated by default. Supports filtering and sorting.

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

takeany ofOptionalDefault: 10

anyOptional

or

numberOptional

skipany ofOptionalDefault: 0

anyOptional

or

numberOptional

idFilterany ofOptional

Comma-separated Game IDs to filter by

anyOptional

or

string[]Optional

allowFuzzyIdFilterbooleanOptional

Set to true to enable fuzzy ID filtering. If false, only returns exact matches.

Default: false

nameFilterany ofOptional

Comma-separated Game names to filter by

anyOptional

or

string[]Optional

allowFuzzyNameFilterbooleanOptional

Set to true to enable fuzzy name filtering. If false, only returns exact matches.

Default: false

tagFilterany ofOptional

Comma-separated list of input tag IDs the resulting game must have

anyOptional

or

string[]Optional

tagExcludeFilterany ofOptional

Comma-separated list of input tag IDs to exclude from the response. Use this to exclude games that have a specific input tag, even if they match the requiredTags filter.

anyOptional

or

string[]Optional

untaggedFilterstring · enumOptional

include: Include all games, regardless of whether they have input tags or not.

exclude: Exclude games that have no input tags.

untagged-only: Only return games that have no input tags. Setting this option will ignore requiredTags and excludeTags, since tagged items shouldn't appear in the results.

Default: includePossible values:

sortFieldstring · enumOptional

Field to sort by

Possible values:

sortOrderstring · enumOptional

Sort order for the selected field

Possible values:

includeTagDatabooleanOptional

Set to true to include additional tags info in the response

Default: false

excludeGamesany ofOptional

Comma-separated list of Game IDs to exclude from the response

anyOptional

or

string[]Optional

Responses

200

Successful response

application/json

default

Error response

application/json

get

/games

HTTPcURLJavaScriptPython

GET /api/games HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "games": [
    {
      "id": "text",
      "name": "text",
      "description": "text",
      "createdAt": "text",
      "updatedAt": "text",
      "inputTags": [
        "text"
      ],
      "mode": "text",
      "customCss": "text"
    }
  ],
  "tags": [
    {
      "id": "text",
      "name": "text",
      "description": "text",
      "createdAt": "text",
      "updatedAt": "text"
    }
  ]
}

Create Game

post

Create a new Game

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

idstringOptional

ID value. Only alphanumeric, underscore, and hyphen are allowed.

Pattern: ^[a-zA-Z0-9_-]+$

namestringRequired

descriptionstringOptional

Responses

200

Successful response

application/json

default

Error response

application/json

post

/games

HTTPcURLJavaScriptPython

POST /api/games HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 48

{
  "id": "text",
  "name": "text",
  "description": "text"
}

{
  "createdGame": {
    "id": "text",
    "name": "text",
    "description": "text",
    "createdAt": "text",
    "updatedAt": "text",
    "mode": "text"
  }
}

Delete Games

delete

Delete one or more Games by their IDs

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

idstring[]Optional

Responses

200

Successful response

application/json

default

Error response

application/json

delete

/games

HTTPcURLJavaScriptPython

DELETE /api/games HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "deletedCount": 1
}

Get Game Count

get

Get Game Count

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

idFilterany ofOptional

Comma-separated Game IDs to filter by

anyOptional

or

string[]Optional

allowFuzzyIdFilterbooleanOptional

Set to true to enable fuzzy ID filtering. If false, only returns exact matches.

Default: false

nameFilterany ofOptional

Comma-separated Game names to filter by

anyOptional

or

string[]Optional

allowFuzzyNameFilterbooleanOptional

Set to true to enable fuzzy name filtering. If false, only returns exact matches.

Default: false

tagFilterany ofOptional

Comma-separated list of input tag IDs the resulting game must have

anyOptional

or

string[]Optional

tagExcludeFilterany ofOptional

Comma-separated list of input tag IDs to exclude from the response. Use this to exclude games that have a specific input tag, even if they match the requiredTags filter.

anyOptional

or

string[]Optional

untaggedFilterstring · enumOptional

include: Include all games, regardless of whether they have input tags or not.

exclude: Exclude games that have no input tags.

untagged-only: Only return games that have no input tags. Setting this option will ignore requiredTags and excludeTags, since tagged items shouldn't appear in the results.

Default: includePossible values:

excludeGamesany ofOptional

Comma-separated list of Game IDs to exclude from the response

anyOptional

or

string[]Optional

Responses

200

Successful response

application/json

default

Error response

application/json

get

/games/count

HTTPcURLJavaScriptPython

GET /api/games/count HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "count": 1
}

Get Game by ID

get

Get a game by its ID.

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

ID value. Only alphanumeric, underscore, and hyphen are allowed.

Pattern: ^[a-zA-Z0-9_-]+$

Query parameters

includeGameObjectsany ofOptionalDefault: false

anyOptional

or

booleanOptionalDefault: false

Responses

200

Successful response

application/json

default

Error response

application/json

get

/games/{id}

HTTPcURLJavaScriptPython

GET /api/games/{id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "game": {
    "id": "text",
    "name": "text",
    "description": "text",
    "createdAt": "text",
    "updatedAt": "text",
    "inputTags": [
      {
        "id": "text",
        "createdAt": "text",
        "updatedAt": "text",
        "name": "text",
        "description": "text"
      }
    ],
    "defaultNumItemsPerRound": 1,
    "mode": "text",
    "modeConfigJson": "text",
    "customCss": "text",
    "gameObjects": [
      {
        "id": "text",
        "name": "text",
        "description": "text",
        "createdAt": "text",
        "updatedAt": "text"
      }
    ]
  }
}

Update Game by ID

put

Update a Game by its ID

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

ID value. Only alphanumeric, underscore, and hyphen are allowed.

Pattern: ^[a-zA-Z0-9_-]+$

Body

application/json

Responses

200

Successful response

application/json

default

Error response

application/json

put

/games/{id}

HTTPcURLJavaScriptPython

PUT /api/games/{id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 163

{
  "data": {
    "id": "text",
    "name": "text",
    "description": "text",
    "inputTags": [
      "text"
    ],
    "defaultNumItemsPerRound": 1,
    "mode": "text",
    "modeConfigJson": "text",
    "customCss": "text"
  }
}

{
  "updatedGameObject": {
    "id": "text",
    "createdAt": "text",
    "updatedAt": "text",
    "name": "text",
    "description": "text",
    "defaultNumItemsPerRound": 1,
    "mode": "text",
    "modeConfigJson": "text",
    "customCss": "text"
  }
}