Help Centre / API / Maps endpoints

Maps endpoints

Updated just now · 6 views ·

List maps

GET /api/v1/maps

Returns your maps, paginated. Query params: industry, state (current/future), archived.

Get a single map

GET /api/v1/maps/{id}

Returns the map with its full stage list and analytics summary.

Create a map

POST /api/v1/maps
Content-Type: application/json

{
  "name": "Order fulfilment",
  "industry": "logistics",
  "description": "..."
}

Returns the created map's ID. Free-tier users are subject to the 2-map cap.

Delete a map

POST /api/v1/maps/{id}/delete

Soft-delete (goes to Recycle Bin). Restore via POST /api/v1/maps/{id}/restore.

Was this article helpful?

0 found this helpful