API keys: read your data from code
Create a key, send it as a bearer token, and read your business, appointments and orders or manage webhooks from your own scripts.
Create keys for your own scripts and tools, or for an app you connect. The API reads your business, appointments and orders, manages webhook subscriptions, and lets a connected app give your Secretary knowledge and live lookups. It cannot change bookings, orders or settings.
- Create a keyIntegration, API keys.
- Copy it nowIt is shown once.
- Call the APIAuthorization: Bearer and the key.
Creating a key
- Open Integration, then API keys, and create a key with a name you will recognise.
- Copy it straight away. Ordina keeps only a fingerprint, so it is never shown again. Lost it? Create a new one and revoke the old one.
You can have up to 10 active keys, on the Business plan. If your plan lapses or moves to Pro, keys stop working until Business is active again.
Revoking a key
Press Revoke next to the key. The confirmation says exactly what stops:
- the key stops working at once;
- the webhooks, connected actions and intakes it set up are switched off (you can switch them back on later);
- Also remove the knowledge it added, ticked unless you untick it, deletes the texts it gave your Secretary.
Webhooks and actions made through the API before Ordina recorded which key made what keep running when you revoke a key, because nothing says which key they came from. The confirmation counts them; switch any of them off yourself in Webhooks or Connected actions.
Each key sees only the webhooks, actions and knowledge it made itself (and older ones made through the API before Ordina recorded this), so one tool can never remove another's. Webhooks you add here yourself are never visible to a key or app.
Endpoints
| Request | Returns |
|---|---|
| GET /api/v1/me | Your business: handle, name, currency, country |
| GET /api/v1/appointments | Appointments, newest first. Optional: limit (up to 100, default 25), status, since (YYYY-MM-DD) |
| GET /api/v1/orders | Orders. Optional: limit, status |
| GET /api/v1/webhooks | The webhook endpoints this key created |
| POST /api/v1/webhooks | Add an endpoint: url, events, description; returns its id and secret |
| DELETE /api/v1/webhooks/{id} | Remove an endpoint |
| GET, POST /api/v1/actions | List or register connected actions |
| GET, PATCH, DELETE /api/v1/actions/{id} | One action and its recent calls; change or remove it |
| GET, POST /api/v1/intakes | List or register intakes: questions your Secretary collects for an app |
| GET /api/v1/knowledge | Knowledge this key pushed |
| PUT, DELETE /api/v1/knowledge/{key} | Push or remove knowledge your Secretary answers from |
All paths are on https://www.useordina.com.
curl https://www.useordina.com/api/v1/appointments?limit=10 \
-H "Authorization: Bearer YOUR_KEY"
A missing or revoked key gets a 401.
Every endpoint, field and example is in the API reference. Building a full integration? Start with the developer overview.
Keeping keys safe
A key can read clients' contact details. Keep it on a server or in a tool's secret settings, never in a website's code or an app people download. Ordina records when each key was last used, not individual requests.
