API Reference

Maps Endpoints

Create, read, and update maps via the API.

Maps Endpoints

All map endpoints require authentication.

List maps

GET /api/v1/maps

Returns all maps owned by the authenticated user.

Response:

[
  {
    "id": "uuid",
    "label": "My Store Locator",
    "slug": "my-store-locator",
    "published": true,
    "createdAt": "2024-01-15T10:30:00Z",
    "updatedAt": "2024-03-20T14:22:00Z"
  }
]

Create a map

POST /api/v1/maps

Creates a new map. You can optionally specify a starter kit.

Request body:

{
  "label": "New Map"
}

Get a map

GET /api/v1/maps/{map_id}

Returns full map details including configuration, fields, filters, and order-by rules.

Response includes:

  • id, label, slug, published
  • config: full MapConfigDto (display type, colors, markers, templates, etc.)
  • fields: array of field configurations
  • filters: array of filter configurations
  • orderBy: array of ordering rules

Update a map

PATCH /api/v1/maps/{map_id}

Update map properties. Send only the fields you want to change.

Request body (example):

{
  "label": "Updated Map Name",
  "published": true,
  "config": {
    "displayType": "cards",
    "buttonColor": "#e11d48",
    "maxZoom": 15
  }
}

Updatable properties:

  • label: map name
  • published: true/false
  • config: any MapConfigDto properties (partial update)
  • fields: field configurations array
  • filters: filter configurations array
  • orderBy: ordering rules array

Map config reference

The config object accepts all MapConfigDto properties. Key ones:

  • displayType: "cards", "map", or "table"
  • buttonColor, backgroundColor: hex color values
  • maxZoom: 1-20
  • darkModeEnabled: boolean
  • paginationEnabled: boolean
  • itemsPerPage: number
  • shareStateInUrl: boolean
  • languages: array of language codes
  • domains: array of allowed embed domains

See Embed Configuration for the full list.

Error responses

  • 404 Not Found: map doesn't exist or you don't own it
  • 400 Bad Request: invalid data in request body
  • 422 Unprocessable Entity: validation errors (returned as field-keyed dictionary)