Get incoming referral

Returns the details of a single incoming referral.

Request

GET /api/oauth/v2/resource/incoming-referrals/{uuid}

Header

Header	Value
Authorization	Bearer {access_token}

URL parameters

Parameter	Type	Required	Description
uuid	string	Yes	Unique ID of the referral

Response

Success (200 OK)

{
  "data": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "services": ["Physiotherapy", "Ultrasound"],
    "diagnose": "M54.5",
    "date": "2026-06-09",
    "customer": {
      "id": "f0e1d2c3-b4a5-6789-fedc-ba9876543210",
      "firstName": "Anna",
      "lastName": "Muster"
    },
    "practitioner": {
      "name": "Dr. Thomas Berger"
    }
  }
}

Response fields

Field	Type	Description
data.id	string (UUID)	Unique ID of the referral
data.services	array	List of referred services
data.diagnose	string | null	Diagnosis for the referral
data.date	string	Referral date (YYYY-MM-DD)
data.customer	object | null	Assigned customer
data.customer.id	string (UUID)	Customer ID
data.customer.firstName	string	Customer first name
data.customer.lastName	string	Customer last name
data.practitioner	object | null	Referring practitioner
data.practitioner.name	string	Name of the referring practitioner

Beispiele

bash

curl -X GET "https://my.offisy.at/api/oauth/v2/resource/incoming-referrals/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	Referral not found