List referrals

Returns a paginated list of all referrals of the company.

Request

GET /api/oauth/v2/resource/referrals

Header

Header	Value
Authorization	Bearer {access_token}

Query parameters

Parameter	Type	Required	Description
offset	integer	No	Start position (default: 0, min: 0)
limit	integer	No	Number of results (default: 50, min: 1, max: 200)

Response

Success (200 OK)

{
  "data": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "services": "Blood count, ECG",
      "diagnose": "Hypertension (I10)",
      "receiverName": "Dr. Thomas Berger",
      "receiverStreet": "Hauptstraße 12",
      "receiverZip": "4020",
      "receiverCity": "Linz",
      "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",
      "services": null,
      "diagnose": null,
      "receiverName": "Radiology Centre Linz",
      "receiverStreet": null,
      "receiverZip": null,
      "receiverCity": 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 fields

Field	Type	Description
data	Array	List of referrals
data[].id	string (UUID)	Unique ID of the referral
data[].services	string | null	Requested services
data[].diagnose	string | null	Diagnosis on the referral
data[].receiverName	string | null	Name of the receiving party
data[].receiverStreet	string | null	Street of the receiving party
data[].receiverZip	string | null	Postal code of the receiving party
data[].receiverCity	string | null	City of the receiving party
data[].date	string | null	Referral date (YYYY-MM-DD)
data[].printed	boolean | null	Whether the referral has been printed
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[].treatingUser	object | null	Treating user
data[].treatingUser.id	string (UUID)	User ID
data[].treatingUser.firstName	string	First name
data[].treatingUser.lastName	string	Last name
meta.total	integer	Total number of referrals
meta.offset	integer	Current start position
meta.limit	integer	Number of returned entries

Beispiele

bash

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

Server

Client-ID

Client-Secret

Parameter

offset integer

limit integer

Zuerst Token anfordern

Possible errors

Status	Code	Description
401	invalid_client	Invalid or missing access token
403	insufficient_scope	Scope medicals not present