REST API

API keys are available on the Premium plan.

Authentication

Create a key in the app under Developers → API keys. Keys start with sk_ and are shown once. Send it as a bearer token:

curl https://APP_URL/admin/api/locations \
  -H "Authorization: Bearer sk_your_key"

A key has full access to your store’s locator data, the same as the app’s own admin, so keep it secret and give each system its own key. You can revoke a key at any time and it stops working immediately.

Admin endpoints

All under /admin/api:

Resource	Endpoints
Account	GET me (shop, plan, usage), GET plans, GET/PUT settings
Locations	GET/POST locations, GET/PUT/DELETE locations/{id}, POST locations/{id}/geocode, GET/PUT locations/{id}/products, POST locations/bulk
Filters (tags)	GET/POST tags, PUT/DELETE tags/{id}
Hours	GET/POST hours-templates, PUT/DELETE hours-templates/{id}
Import and export	POST import, GET import/template, GET import-jobs, GET export, POST/DELETE sample-data
Sync	PUT sheet, POST sheet/sync, PUT shopify-sync, POST shopify-sync/run
Products	GET/POST products, GET shopify/products (search your Shopify catalogue)
Leads	GET leads, GET/PUT leads/{id}, POST leads/{id}/approve, POST leads/{id}/reject, GET/PUT lead-routing, GET/PUT territories
Analytics	GET analytics/summary, GET analytics/heatmap, GET analytics/export
Developers	GET/POST api-keys, DELETE api-keys/{id}, GET/POST webhooks, DELETE webhooks/{id}, GET webhooks/{id}/deliveries

Endpoints for features on a higher plan return 402 with "error": "plan_limit".

Public search API

The storefront API needs no key. It lives under /api/v1/shops/{handle}:

curl "https://APP_URL/api/v1/shops/my-store/search?lat=51.52&lng=-0.08&radius=10&unit=km&open_now=true"

Search parameters:

Parameter	Meaning
lat, lng	Centre point
q	Place to geocode, such as “Brooklyn” or “SW1A 1AA”
text	Fuzzy match on name, address, city and postcode
radius, unit	Radius in km or mi
bounds	Map bounds as south,west,north,east
tags, tag_mode	Comma-separated tag slugs, matched any or all
product	Product id, Shopify GID or handle
open_now	Only open locations
limit, offset	Pagination

Other public endpoints: config, autocomplete, locations/{slug}, events, contact and dealer-applications.