Games

Game management and retrieval operations

Get games

get
/api/games

Retrieve all active games or all games (including inactive) with the 'all' query parameter

Query parameters
allbooleanOptional

Include inactive games

Responses
chevron-right
200

List of games

application/json
get
/api/games
200

List of games

Create a new game

post
/api/games

Create a new game at a specific parcel location (Admin only)

Body
namestringRequired

Game name

Example: Puzzle Master
xinteger · min: -150 · max: 150Required

X coordinate of the parcel

Example: 10
yinteger · min: -150 · max: 150Required

Y coordinate of the parcel

Example: 20
Responses
post
/api/games

Update a game

patch
/api/games/{id}

Update game name and parcel location (Admin only)

Path parameters
idstring · uuidRequired

Game ID (UUID)

Body
namestringRequired

Game name

Example: Puzzle Master
xinteger · min: -150 · max: 150Required

X coordinate of the parcel

Example: 10
yinteger · min: -150 · max: 150Required

Y coordinate of the parcel

Example: 20
Responses
patch
/api/games/{id}

No content

Deactivate a game

patch
/api/games/{id}/deactivate

Deactivate a game by ID (Admin only)

Path parameters
idstring · uuidRequired

Game ID (UUID)

Responses
patch
/api/games/{id}/deactivate

No content

Last updated