Developer overview
The direct.eat API gives your own software, or your agency’s, access to a restaurant’s menus, orders and customers. Webhooks tell your server the moment something happens, such as a new order.
Typical uses:
- A bridge that puts orders on a till or kitchen screen we don’t connect to directly.
- A spreadsheet or dashboard that pulls orders every night.
- A Slack or WhatsApp alert for big orders, using webhooks with Zapier or Make.
- Syncing customers who agreed to marketing into another tool.
At a glance
Section titled “At a glance”| Base URL | https://api.direct.eat/v1 |
| Format | JSON over HTTPS. Money is integer pence with "currency": "GBP". Timestamps are ISO 8601 in UTC. |
| Authentication | Authorization: Bearer de_live_… (or de_test_…) with an organisation API key |
| Version | Dated versions, sent in the DirectEat-Version header. Current: 2026-11-17 |
| Rate limits | 300 reads and 60 writes per minute per key |
| Spec | OpenAPI 3.1 at https://app.direct.eat/openapi.json |
| Plans | Read-only API and webhooks: Growth plan and above. Write access: Pro plan |
Authentication
Section titled “Authentication”Every request needs an API key in the Authorization header:
curl https://api.direct.eat/v1/shops \ -H "Authorization: Bearer de_live_YOUR_KEY"Keys belong to the whole organisation. When you create one you choose its scopes (what it can do), which shops it can see, and optionally an expiry date and an IP allow-list. Owners and admins create keys in Settings → API and webhooks. See API keys and scopes.
There are two kinds of key:
- Live keys (
de_live_…) see real orders and menus. - Test keys (
de_test_…) only see test orders, never live ones.
Versioning
Section titled “Versioning”The API uses dated versions. Each key is pinned to the version that was current when it was made. To use a different version for one request, send it in a header:
DirectEat-Version: 2026-11-17Every response tells you which version it used, in the DirectEat-Version response header. An unsupported version returns 400 with the code unsupported_version. Today there is one version, 2026-11-17.
Plan gating
Section titled “Plan gating”| What | Starter | Growth | Pro |
|---|---|---|---|
| API keys and read endpoints | – | Yes | Yes |
| Webhooks | – | Yes | Yes |
Write scopes and write endpoints (PATCH /orders/{id}, POST /orders/{id}/status) |
– | – | Yes |
On a plan without API access, every request returns 403 with the code upgrade_required. On Growth, a write call returns 403 upgrade_required too.
What’s in the API
Section titled “What’s in the API”| Resource | Endpoints | Scope |
|---|---|---|
| Shops | GET /shops |
menu:read |
| Menu | GET /shops/{shop_id}/menu |
menu:read |
| Orders | GET /orders, GET /orders/{order_id} |
orders:read |
| Order updates | PATCH /orders/{order_id}, POST /orders/{order_id}/status |
orders:write |
| Customers | GET /customers, GET /customers/{customer_id} |
customers:read |
| Events | GET /events |
orders:read |
GET /v1 (no key needed) returns the current version, supported versions, scopes and the list of resources. Full details are in the API reference.
Privacy by design
Section titled “Privacy by design”- Orders include the customer’s first name only, never their email, phone or address.
- Customer endpoints return an email or phone number only if that customer subscribed to marketing on that channel. Everyone else is returned without contact details.
- Keys are stored only as a fingerprint. We can’t show a key again after it’s created.
- Every API request is logged against the key that made it.
Using the API to process a restaurant’s customer data makes you a processor (or sub-processor) for that restaurant. See Data processing.
Start here
Section titled “Start here”Was this page helpful?