Patient Appointments

General
URL	https://patient.samedi.de/api/booking/v3/events/upcoming
Parameters	`client_id`
Authentication	OAuth
Scope	appointments:read

With a valid access token in the Authorization header, the Client can request all upcoming appointments of the Resource Owner, to whom the access token belongs to.

Sample Request:

GET /api/booking/v3/events/upcoming?client_id=CLIENT_ID HTTP/1.1
Host: patient.samedi.de
Authorization: Bearer ACCESS_TOKEN
Content-Type: application/json

Sample Response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "appointments": [
        {
            "id": "2DXn7hiBKVuSiUJToeWyJc14f9vn",
            "name": "Krebsvorsorgeuntersuchung",
            "practice_id": "5y2ws8b5hw4ab7yf",
            "practice_name": null,
            "event_category_id": null,
            "event_type_id": 30,
            "cancelled_at": "2022-09-21T12:00:00+02:00",
            "starts_at": "2022-09-22T10:00:00+02:00",
            "is_cancellable": false,
            "is_video_consultation": false,
            "cancellation_link": null,
            "access_video_consultation_link": null
        },
        {
            "id": "Z2wrydnfG6AyicT73YFDA3zS4xbt",
            "name": "Nuvaxovid 1. Auffrischimpfung (IKNK)",
            "practice_id": "9yrnjbqpcfwgsajr",
            "practice_name": "MVZ Berlin",
            "event_category_id": 10,
            "event_type_id": 50,
            "cancelled_at": null,
            "starts_at": "2022-09-21T10:00:00+02:00",
            "is_cancellable": true,
            "is_video_consultation": false,
            "cancellation_link": "https://patient.samedi.de/QOfcfYyEuAxq63ECabOWka",
            "access_video_consultation_link": null
        },
        {
            "id": "qmkgYvxz4Bp6HGtK6CG79xp1sx3B",
            "name": "Video-Sprechstunde",
            "practice_id": "9yrnjbqpcfwgsajr",
            "practice_name": "MVZ Berlin",
            "event_category_id": 25,
            "event_type_id": 20,
            "cancelled_at": null,
            "starts_at": "2022-09-22T09:00:00+02:00",
            "is_cancellable": true,
            "is_video_consultation": true,
            "cancellation_link": "https://patient.samedi.de/v3n22jxhp21wkjfzisl1o",
            "access_video_consultation_link": "https://patient.samedi.de/access-video-consultation/C4cDEbTl83oODL7gZ0AkgQ"
        }
    ]
}

Response Parameters:

Field	Type	Description
id	string	appointment identifier
name	string	appointment name
practice_id	string	practice id of the institution
practice_name	string or null	institution name
event_category_id	integer or null	id of the event category that appointment belongs to
event_type_id	integer or null	id of the event type that appointment belongs to. -1 stands for already deleted event type
cancelled_at	string or null	the time when an appointment was cancelled (in ISO8601)
starts_at	string	starting time of an appointment (in ISO8601)
is_cancellable	boolean	is the appointment cancellable?
is_video_consultation	boolean	is the appointment type a video consultation?
cancellation_link	string or null	link to appointment cancellation. It’s present when the appointment is cancellable
access_video_consultation_link	string or null	link to access video cunsultation. It’s present when the appointment type is a video consultation

Possible Errors:

Error	Status Code	Description
forbidden	403	missing, invalid or blacklisted `client_id`
forbidden	403	access token has invalid scope
unauthorized	401	invalid oauth token