Skip to content

Maps API

The Maps API provides CRUD operations for map data stored on the ctx.gg platform.

List all public maps, with optional filtering.

Query Parameters:

ParameterTypeDescription
pagenumberPage number (default: 1)
limitnumberResults per page (default: 20, max: 100)
searchstringSearch by map name
authorstringFilter by author user ID

Response:

{
"maps": [
{
"id": "map-uuid",
"name": "Arena v2",
"author": { "id": "user-uuid", "username": "player1" },
"createdAt": "2026-02-01T12:00:00Z",
"updatedAt": "2026-02-10T15:30:00Z"
}
],
"total": 42,
"page": 1,
"limit": 20
}

Get a specific map, including its full entity data.

Response:

{
"id": "map-uuid",
"name": "Arena v2",
"version": 1,
"author": { "id": "user-uuid", "username": "player1" },
"entities": [...],
"createdAt": "2026-02-01T12:00:00Z",
"updatedAt": "2026-02-10T15:30:00Z"
}

Create a new map. Requires authentication.

Request Body:

{
"name": "My New Map",
"entities": [...]
}

Response: 201 Created with the created map object.

Update an existing map. Only the map author can update.

Request Body:

{
"name": "Updated Map Name",
"entities": [...]
}

Delete a map. Only the map author can delete.

Response: 204 No Content