Get started

Public API

Connect your website or store to your workspace: read its products, and send it orders and contacts.

What you can do

The public API is a small, website-facing API. With one API key, your site can:

List the workspace's active products, with search and category filter. See Products.
Create orders, which appear in Orders with the source Website. See Orders.
Create contacts from sign-up or enquiry forms, matched to existing customers by phone or email. See Contacts.

Base URL

Every endpoint is relative to your workspace's API base URL. The exact address is shown on Integrations → API under Base URL.

Base URL

https://<your-api-host>/api/public/v1

Your first request

Step 1: Create a key on Integrations → API. See API keys.
Step 2: Send it in the X-Api-Key header, with Accept: application/json.

List products

curl "https://<your-api-host>/api/public/v1/products?per_page=5" \
  -H "X-Api-Key: mf_your_key" \
  -H "Accept: application/json"

Open API Access

What the API does not do

The public API covers the three endpoints above only. It does not read or change orders after they are created, read contacts, send messages, or deliver webhooks. Keys have no scopes or environments: every key has the same access.