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
- Revoke it at once in Admin → Integrations & API; it stops working with the next request
- Create a new key with the same scopes and update your systems
- Check the request log for calls you do not recognise
- If the key could write, review the records it created
The reference below is in English, like the OpenAPI document.
Scopes
customers:read | List and read customers |
customers:write | Create customers and update their contact details |
quotations:read | List and read quotations (with items) |
quotations:write | Create draft quotations |
invoices:read | List and read invoices (with items and payments) |
invoices:write | Create draft invoices |
orders:read | List and read shop orders |
inquiries:read | List and read leads |
inquiries:write | Create leads (goes through the same notifications as the website form) |
products:read | List and read products with stock |
webhooks:read | Read the webhook event catalog and delivery log |
payments:read | List and read invoice payments |
stock:read | Read stock locations and stock levels |
stock:write | Add or remove stock (adjustments, write-offs) |
appointments:read | List and read appointments |
pos:read | List and read till sales and refunds |
tasks:read | List and read tasks |
tasks:write | Create tasks and change them (status, due date, priority) |
attachments:write | Upload photos and PDFs (optionally onto a task) |
sensors:write | Upload readings of sensor devices (temperature, humidity, fuel level) — Sensors & cold chain |
catalog:read | Read the catalog: products, product categories, services and bookable services |
bookings:read | Read appointments and free time slots |
bookings:write | Book appointments (same checks as online booking) |
webhooks:write | List, 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.