Termine für Kontakt abrufen - API Hub
← Zurück zum API Hub

Termine für Kontakt abrufen

GET /contacts/{contactId}/appointments

Ruft eine Liste aller Termine ab, die einem bestimmten Kontakt (Patienten) zugeordnet sind. Das Ergebnis kann über Query-Parameter gefiltert werden.

Erforderliche Header

Authorization: Bearer {{ token }}
Content-Type: application/json
Version: 2021-04-15 // Kalender/Termin-Version

URL-Parameter

Du musst die contactId (die du über die "Kontakt suchen" oder "Upsert"-Funktion erhältst) in der URL ersetzen.

# Beispiel-Aufruf
.../contacts/a1b2c3d4e5f6g7h8i9j0/appointments

Optionale Query-Parameter

Du kannst die Ergebnisse filtern, um z.B. nur zukünftige Termine zu erhalten.

startDate ISO 8601-Datum (z.B. 2025-10-23T00:00:00Z). Liefert Termine, die nach diesem Datum beginnen.
endDate ISO 8601-Datum. Liefert Termine, die vor diesem Datum enden.
status Filtert nach Status (z.B. confirmed, new, cancelled).
# Beispiel: Nur bestätigte Termine ab jetzt
.../appointments?status=confirmed&startDate=2025-10-23T17:00:00+02:00

Mögliche Antworten (Response)

Antwort (200 OK): Liste der Termine

Die Antwort enthält ein appointments-Array. Wenn der Kontakt keine Termine hat, ist dieses Array leer.

{
  "appointments": [
    {
      "id": "APPOINTMENT_ID_1",
      "calendarId": "fu4y48c9PlUoyFxnCw2A", // Der Kalender (Behandlungsart)
      "locationId": "UFeZwU5X6PIJLwU2XO3k",
      "contactId": "a1b2c3d4e5f6g7h8i9j0",
      "userId": "15tDtK9qqUdfHTtrL5np", // Der Therapeut
      "startTime": "2025-10-25T14:00:00+02:00",
      "endTime": "2025-10-25T15:30:00+02:00",
      "status": "confirmed"
    },
    {
      "id": "APPOINTMENT_ID_2",
      "calendarId": "1nBVY6R2cyx4qw86FJVD",
      "locationId": "UFeZwU5X6PIJLwU2XO3k",
      "contactId": "a1b2c3d4e5f6g7h8i9j0",
      "userId": "15tDtK9qqUdfHTtrL5np",
      "startTime": "2025-11-05T10:00:00+01:00",
      "endTime": "2025-11-05T11:00:00+01:00",
      "status": "new"
    }
  ],
  "meta": {
    "total": 2
  }
}