Skip to content
14-day free trial, no card9 languages176 business types · 50 apps
EN· USD
Try a live demoStart free trial

API keys and scopes

What a key may read and write, and the limits it carries from the person who created it.

Authorization: Bearer fx_live_…

Rules every key follows

  • A key is shown once; only its SHA-256 hash is stored
  • A key can only cover areas its creator can open; the all-areas key is for the workspace owner only
  • A key works inside its creator's branches and companies, like the person in the back office; records it creates go to that person's branch
  • When the creator is deactivated or deleted, the key stops working
  • Keys can expire and can be revoked at any time; every request is in the request log

Recognising a key

Every key starts with fx_live_. The key list shows its first 14 characters, so you can tell keys apart without seeing the whole key.

If a key leaks

  1. Revoke it at once in Admin → Integrations & API; it stops working with the next request
  2. Create a new key with the same scopes and update your systems
  3. Check the request log for calls you do not recognise
  4. If the key could write, review the records it created

The reference below is in English, like the OpenAPI document.

Scopes

customers:readList and read customers
customers:writeCreate customers and update their contact details
quotations:readList and read quotations (with items)
quotations:writeCreate draft quotations
invoices:readList and read invoices (with items and payments)
invoices:writeCreate draft invoices
orders:readList and read shop orders
inquiries:readList and read leads
inquiries:writeCreate leads (goes through the same notifications as the website form)
products:readList and read products with stock
webhooks:readRead the webhook event catalog and delivery log
payments:readList and read invoice payments
stock:readRead stock locations and stock levels
stock:writeAdd or remove stock (adjustments, write-offs)
appointments:readList and read appointments
pos:readList and read till sales and refunds
tasks:readList and read tasks
tasks:writeCreate tasks and change them (status, due date, priority)
attachments:writeUpload photos and PDFs (optionally onto a task)
sensors:writeUpload readings of sensor devices (temperature, humidity, fuel level) — Sensors & cold chain
catalog:readRead the catalog: products, product categories, services and bookable services
bookings:readRead appointments and free time slots
bookings:writeBook appointments (same checks as online booking)
webhooks:writeList, create and delete webhook endpoints

Next: Sandbox workspace

Try the API on a personal demo workspace with sample data. Nothing you do there reaches the outside world.

Sandbox workspace