Patientenbriefe abrufen

Gibt eine paginierte Liste aller Patientenbriefe des Unternehmens zurück.

Request

GET /api/oauth/v2/resource/patient-letters

Header

Header	Wert
Authorization	Bearer {access_token}

Query-Parameter

Parameter	Typ	Pflicht	Beschreibung
offset	integer	Nein	Startposition (Standard: 0, Min: 0)
limit	integer	Nein	Anzahl Ergebnisse (Standard: 50, Min: 1, Max: 200)

Response

Erfolg (200 OK)

{
  "data": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "name": "Befundbericht Juni 2026",
      "text": "Sehr geehrte Kollegin, sehr geehrter Kollege, ich berichte über folgende Befunde ...",
      "date": "2026-06-09",
      "printed": false,
      "customer": {
        "id": "f0e1d2c3-b4a5-6789-fedc-ba9876543210",
        "firstName": "Anna",
        "lastName": "Muster"
      },
      "treatingUser": {
        "id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
        "firstName": "Dr. Maria",
        "lastName": "Huber"
      }
    },
    {
      "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "name": null,
      "text": null,
      "date": "2026-06-08",
      "printed": true,
      "customer": {
        "id": "f0e1d2c3-b4a5-6789-fedc-ba9876543210",
        "firstName": "Anna",
        "lastName": "Muster"
      },
      "treatingUser": {
        "id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
        "firstName": "Dr. Maria",
        "lastName": "Huber"
      }
    }
  ],
  "meta": {
    "total": 17,
    "offset": 0,
    "limit": 50
  }
}

Response-Felder

Feld	Typ	Beschreibung
data	Array	Liste der Patientenbriefe
data[].id	string (UUID)	Eindeutige ID des Patientenbriefs
data[].name	string | null	Bezeichnung des Briefs
data[].text	string | null	Inhalt des Briefs
data[].date	string	Datum des Briefs (YYYY-MM-DD)
data[].printed	boolean | null	Gibt an, ob der Brief gedruckt wurde
data[].customer	object | null	Zugeordneter Kunde
data[].customer.id	string (UUID)	Kunden-ID
data[].customer.firstName	string	Vorname des Kunden
data[].customer.lastName	string	Nachname des Kunden
data[].treatingUser	object | null	Behandelnde:r Benutzer:in
data[].treatingUser.id	string (UUID)	Benutzer-ID
data[].treatingUser.firstName	string	Vorname
data[].treatingUser.lastName	string	Nachname
meta.total	integer	Gesamtanzahl der Patientenbriefe
meta.offset	integer	Aktuelle Startposition
meta.limit	integer	Anzahl der zurückgegebenen Einträge

Beispiele

bash

curl -X GET "https://my.offisy.at/api/oauth/v2/resource/patient-letters?offset=0&limit=50" \
  -H "Authorization: Bearer {access_token}"

Server

Client-ID

Client-Secret

Parameter

offset integer

limit integer

Zuerst Token anfordern

Mögliche Fehler

Status	Code	Beschreibung
401	invalid_client	Ungültiger oder fehlender Access Token
403	insufficient_scope	Scope medicals nicht vorhanden