Quickstart

1. Make an API key

Open your configurator’s /developer page, signed in with your personal manufacturer account. Under API keys, name the key after the system that will use it (for example “ERP sync”) and press Create key. Copy the key now: it is shown once.

Leave Include customer details off unless that system needs names, emails and mobiles.

2. Read your leads

curl -H "Authorization: Bearer gak_live_..." \
  "https://yourbrand.3dconfigurator.com.au/api/v1/leads?limit=2"

{
  "data": [
    {
      "id": "lead_542",
      "build_id": "bld_9a440c74f6666053cd29b31e1c381d64",
      "created_at": "2026-09-30T07:16:49.529437+00:00",
      "updated_at": "2026-09-30T07:16:49.529437+00:00",
      "status": "proposed",
      "dealership": "Norris Group",
      "vehicle": { "name": "Toyota Hilux Double Cab SR5 2026", "colour": "Crystal Pearl" },
      "items": [
        { "sku": "G4X4-GLASSCANOPY-HILUX", "name": "Alloy Canopy, Lift-up Glass Doors", "qty": 1, "unit_price": 4950 },
        { "sku": "G4X4-BULLBAR-4X4", "name": "4x4 Alloy Bull Bar", "qty": 1, "unit_price": 2650 }
      ],
      "total": 10403,
      "weekly": 46,
      "currency": "AUD",
      "marketing_consent": false
    }
  ],
  "has_more": true,
  "next_cursor": "MjAyNi0wOS0zMFQwNzoxNjo0OS41Mjk0MzcrMDA6MDB8NTQy"
}

Prices are AUD including GST. To keep a system in step, see Reading leads or run sync-leads.mjs.

3. Receive a webhook

1. Run an https endpoint. webhook-receiver.mjs is a complete one (npm install standardwebhooks); any Standard Webhooks library works.
2. On /developer under Webhooks, enter its URL, tick the events you want, press Add webhook, and copy the signing secret (shown once) into your endpoint’s settings.
3. Press Send test: your endpoint gets a signed webhook.test event. The next “Get my build” on your configurator sends lead.created and build.created.

Always check the signature before trusting a body: see Webhooks.

4. From a webhook to the full record

A webhook is short on purpose. Use its ids to read the rest:

curl -H "Authorization: Bearer gak_live_..." \
  "https://yourbrand.3dconfigurator.com.au/api/v1/leads/lead_542"
curl -H "Authorization: Bearer gak_live_..." \
  "https://yourbrand.3dconfigurator.com.au/api/v1/builds/bld_9a440c74f6666053cd29b31e1c381d64"