Get doctor letter

Returns the details of a single doctor letter.

Request

GET /api/oauth/v2/resource/doctor-letters/{uuid}

Header

Header	Value
Authorization	Bearer {access_token}

URL parameters

Parameter	Type	Required	Description
uuid	string	Yes	Unique ID of the doctor letter

Response

Success (200 OK)

{
  "data": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "Referral letter",
    "text": "Dear colleague, I am writing to report on the patient Anna Muster...",
    "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"
    },
    "receiver": {
      "title": "Dr.",
      "firstName": "Klaus",
      "lastName": "Berger",
      "institute": "Internal Medicine Specialist Practice",
      "street": "Hauptstraße 12",
      "zip": "4020",
      "city": "Linz",
      "country": "AT",
      "tel": "0732123456",
      "telCode": "+43",
      "fax": null,
      "email": "k.berger@example.at"
    }
  }
}

Response fields

Field	Type	Description
data.id	string (UUID)	Unique ID of the doctor letter
data.name	string | null	Name of the doctor letter
data.text	string | null	Content of the doctor letter
data.date	string | null	Date of the doctor letter (YYYY-MM-DD)
data.printed	boolean | null	Whether the letter has been printed
data.customer	object | null	Assigned patient
data.customer.id	string (UUID)	Customer ID
data.customer.firstName	string	First name
data.customer.lastName	string	Last name
data.treatingUser	object | null	Treating user
data.treatingUser.id	string (UUID)	User ID
data.treatingUser.firstName	string	First name
data.treatingUser.lastName	string	Last name
data.receiver	object | null	Recipient of the doctor letter
data.receiver.title	string | null	Title
data.receiver.firstName	string | null	First name
data.receiver.lastName	string | null	Last name
data.receiver.institute	string | null	Institute or facility
data.receiver.street	string | null	Street
data.receiver.zip	string | null	Postal code
data.receiver.city	string | null	City
data.receiver.country	string | null	Country (ISO 3166-1 alpha-2)
data.receiver.tel	string | null	Phone number
data.receiver.telCode	string | null	Phone country code
data.receiver.fax	string | null	Fax number
data.receiver.email	string | null	Email address

Beispiele

bash

curl -X GET "https://my.offisy.at/api/oauth/v2/resource/doctor-letters/b2c3d4e5-f6a7-8901-bcde-f01234567890" \
  -H "Authorization: Bearer {access_token}"

Server

Client-ID

Client-Secret

Parameter

uuid *string

Zuerst Token anfordern

Possible errors

Status	Code	Description
401	invalid_client	Invalid or missing access token
403	insufficient_scope	Scope medicals not present
404	not_found	Doctor letter not found