Endpoints / getAppointments

getAppointments

Termine abfragen

Termine eines Patienten — oder eines ganzen Kalenders, wenn calendarid mitgegeben wird. Provisorische Termine mit Status PR und gelöschte Termine sind immer ausgeschlossen.

HTTP Request

POST https://dev.vitabyte.ch/v1/agenda/getAppointments

Auth basicAuth apiKey

Request Parameters

Zwei Modi: ohne calendarid filtert der Endpoint nach Patient; mit calendarid auf die Ressource und den Zeitraum from/until — patid, appointment, comment und period werden dann ignoriert.

Parameter	Pflicht	Typ	Beispiel / Default
`patid` 0 oder fehlend bedeutet kein Patientenfilter — es kommen Termine aller Patienten.	optional	integer	default: `0` 789
`appointment` Contains-Match auf den Termintext.	optional	string	Labor
`comment` Contains-Match auf den Kommentar.	optional	string
`from` Datum oder Unix-Timestamp. Nur wirksam, wenn from und until beide gesetzt sind.	optional	string	2026-05-01
`until` Datum oder Unix-Timestamp. Nur wirksam, wenn from und until beide gesetzt sind.	optional	string	2026-05-31
`period` Greift nur, wenn from und until fehlen.	optional	string enum: future \| past \| all
`calendarid` Aktiviert den Kalender-Modus. 0 führt zum Fehler "Please provide a calendar id.".	optional	integer

Response Parameters

Sortiert absteigend nach Datum. ⚠ Die Unix-Timestamps heissen je nach Modus unterschiedlich: Patienten-Modus date_unix/end_unix, Kalender-Modus dateTs/endTs. Der Kalender-Modus liefert zudem kein calendarid.

Field	Typ	Beschreibung
`id`	integer	Termin-ID
`date`	string	Beginn (Datum und Uhrzeit)
`end`	string	Ende (Datum und Uhrzeit)
`duration`	integer	Dauer in Minuten
`displayedduration`	string	Sichtbare Dauer in Minuten
`patid`	integer	Patienten-ID (0 bei Terminen ohne Patient)
`appointment`	string	Termintext
`comment`	string	Kommentar
`color`	string	Hintergrundfarbe aus der Terminart
`state`	string	Terminstatus, siehe createAppointment
`calendar`	string	Name des Kalenders
`calendarid`	integer	Kalender-ID (nur im Patienten-Modus)

Demo

Referenz und Beispiele stammen aus der internen API-Collection — die OpenAPI-Spec deckt diesen Endpoint noch nicht ab.

POST https://dev.vitabyte.ch/v1/agenda/getAppointments

Payload

{
    "patid": 789,
    "appointment": "",
    "comment": "",
    "from": "2026-05-01",
    "until": "2026-05-31"
}

Response

{
    "status": true,
    "msg": "Success",
    "result": [
        {
            "id": 1984,
            "date": "2026-05-20 09:45:00",
            "end": "2026-05-20 10:00:00",
            "date_unix": 1779608700,
            "end_unix": 1779609600,
            "duration": 15,
            "displayedduration": "",
            "patid": 789,
            "appointment": "Labor",
            "comment": "CRP",
            "color": "#c5d4fc",
            "state": "2",
            "calendar": "Labor",
            "calendarid": 3
        },
        {
            "id": 1922,
            "date": "2026-05-16 13:30:00",
            "end": "2026-05-16 14:00:00",
            "date_unix": 1779276600,
            "end_unix": 1779278400,
            "duration": 30,
            "displayedduration": "",
            "patid": 789,
            "appointment": "Konsultation",
            "comment": "",
            "color": "#d8f0d2",
            "state": "2",
            "calendar": "Sprechzimmer 1",
            "calendarid": 2
        }
    ]
}