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. The API reads your business, appointments and orders, and manages webhook subscriptions. It cannot change bookings, orders or settings.

  1. Create a keyIntegration, API keys.
  2. Copy it nowIt is shown once.
  3. Call the APIAuthorization: Bearer and the key.

Creating a key

  1. Open Integration, then API keys, and create a key with a name you will recognise.
  2. 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 Pro and Business. If your plan lapses, keys stop working until it is active again.

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 Your webhook endpoints
POST /api/v1/webhooks Add an endpoint: url, events, description; returns its id and secret
DELETE /api/v1/webhooks/{id} Remove an endpoint

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.

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.

Did this answer it?If not, write to help@useordina.com with your handle, or contact us. A person replies.
Contact us