Preview

Ordinavo Connect API

Submit external appointment requests and service needs to Ordinavo in a structured way.

Base URL

The final API base URL is provided per environment and tenant. The documentation uses the preview URL for examples.

https://api.ordinavo.de/connect/v1

Quickstart

  1. Receive credentials
  2. Authenticate
  3. Create an appointment request
  4. Store the request ID
  5. Read status or receive a webhook

Example: first appointment request

POST/connect/v1/appointment-requests
POST /connect/v1/appointment-requests
Authorization: Bearer {access_token}
Content-Type: application/json
Idempotency-Key: 7b56e4c2-2e7a-4b7c-bf44-291d2c9d1f91
{
  "externalReference": "REQ-2026-000184",
  "serviceType": "maintenance_visit",
  "priority": "normal",
  "customer": {
    "name": "Muster GmbH",
    "contactName": "Max Mustermann",
    "email": "max.mustermann@example.com",
    "phone": "+49 201 000000"
  },
  "location": {
    "street": "Musterstrasse 12",
    "postalCode": "45127",
    "city": "Essen",
    "country": "DE"
  },
  "preferredTimeWindows": [
    {
      "date": "2026-06-22",
      "from": "09:00",
      "to": "12:00",
      "timeZone": "Europe/Berlin"
    }
  ],
  "description": "Wartungstermin fuer Anlage im Eingangsbereich.",
  "metadata": {
    "source": "customer_portal",
    "terminalId": "terminal-essen-01"
  }
}

Example response

{
  "id": "apr_01JZ7YQ1H7MP6Q5V8N9D4G3A2B",
  "status": "Submitted",
  "externalReference": "REQ-2026-000184",
  "createdAt": "2026-06-15T14:30:00Z",
  "links": {
    "self": "/connect/v1/appointment-requests/apr_01JZ7YQ1H7MP6Q5V8N9D4G3A2B",
    "status": "/connect/v1/appointment-requests/apr_01JZ7YQ1H7MP6Q5V8N9D4G3A2B/status"
  }
}
Privacy note

Only submit data that is required to process the request. Sensitive data should only be processed when this is contractually, legally and technically intended.