# 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.

- Source: https://support.unifunl.io/en/help/account-billing/api-and-developers
- Category: Account & billing (`account-billing`)
- Language: en
- Updated: 2026-08-20

---

**Settings**, then **API keys**. The public API gives external systems read-only access to your orders and your bookings.

![The API keys page, with the quick-start guide on the page itself.](https://support.unifunl.io/help/screenshots/42-api-keys.jpg)

## 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.

> **The other direction** — if you run a custom store and you want Unifunl to read *your* products and orders, that is the **Unifunl Commerce API**. Implement it, then connect it through **Integrations**, **Custom store**, with a base URL and a token. See [Store integrations](https://support.unifunl.io/en/help/channels-integrations/store-integrations).

## 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.

[Team and roles](https://support.unifunl.io/en/help/account-billing/team-and-roles)

## Related articles

- [Security and data](https://support.unifunl.io/en/help/account-billing/security-and-data.md): What happens to your data and your customers', the controls you hold, and how to audit what was sent.
- [Store integrations](https://support.unifunl.io/en/help/channels-integrations/store-integrations.md): The full catalogue of supported e-commerce platforms, what each one syncs, and what you need to connect it.
- [Credits and billing](https://support.unifunl.io/en/help/account-billing/credits-and-billing.md): How credits are spent and topped up, what the Usage page tells you, what happens at zero, and how the plans compare.