API and developers
Give external systems read-only access to your orders and bookings — usage rules, quick start, and the reverse direction for custom stores.
Settings, then API keys. The public API gives external systems read-only access to your orders and your bookings.
Usage rules
| Rule | Detail |
|---|---|
| Read only | Keys can read orders and resource allocations, and nothing else. No writes are possible. |
| Rate limit | 120 requests per minute per key. |
| Authentication | The key is sent in the x-api-key header. |
| Server side only | Call the API from your server, never from code running in the browser — your key would be exposed. |
Quick start
List orders. Available filters are page, take, search, status, source, dateFrom and dateTo, customerEmail and customerPhone.
curl -H "x-api-key: YOUR_API_KEY" \
"https://api.unifunl.io/api/v1/public/orders?page=1&take=20"
List bookings. Available filters are page, take, status, resourceTypeId, and creation, start and end date ranges.
curl -H "x-api-key: YOUR_API_KEY" \
"https://api.unifunl.io/api/v1/public/allocations?page=1&take=20"
What people use it for
- Zapier or Make — trigger a workflow on every new order.
- ERP or accounting — pull orders back into your management system.
- Dashboards — feed your own reports with your sales data.
FAQ and troubleshooting
Who can create an API key?
Treat this as an owner-only page. Keys are revocable individually, so issue one per integration rather than sharing a single key.
I am getting rate-limited
The limit is 120 requests per minute per key. Batch your requests with page and take rather than fetching records one at a time.
Can the API create or update orders?
No. The public API is read-only by design. To let Unifunl write into your store, use a store integration instead.
What's next?
Review who on your team can reach what.