Skip to content

List health notifications

Returns a paginated list of all health notifications of the company.

Request

GET /api/oauth/v2/resource/health-notifications

HeaderValue
AuthorizationBearer {access_token}

Query parameters

ParameterTypeRequiredDescription
offsetintegerNoStart position (default: 0, min: 0)
limitintegerNoNumber of results (default: 50, min: 1, max: 200)

Response

Success (200 OK)

json
{
  "data": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "date": "2026-06-09",
      "customStartDate": "2026-06-09",
      "customEndDate": "2026-06-16",
      "diagnose": "Common cold",
      "reason": null,
      "bedrest": true,
      "curfew1StartTime": "08:00",
      "curfew1EndTime": "12:00",
      "curfew2StartTime": null,
      "curfew2EndTime": null,
      "hospitalCareStartTime": null,
      "hospitalCareEndTime": null,
      "hospitalCareStartDate": null,
      "hospitalCareEndDate": null,
      "occupationalDisease": 0,
      "electricalAccident": false,
      "reorderDate1": "2026-06-12",
      "reorderDate2": null,
      "reorderDate3": null,
      "reasonForBackdating": null,
      "specialIllnessReason": null,
      "noticeForInsurance": null,
      "printed": false,
      "customer": {
        "id": "f0e1d2c3-b4a5-6789-fedc-ba9876543210",
        "firstName": "Anna",
        "lastName": "Muster"
      }
    }
  ],
  "meta": {
    "total": 17,
    "offset": 0,
    "limit": 50
  }
}

Response fields

FieldTypeDescription
dataArrayList of health notifications
data[].idstring (UUID)Unique ID of the health notification
data[].datestring | nullDate of the health notification (YYYY-MM-DD)
data[].customStartDatestring | nullCustom start date (YYYY-MM-DD)
data[].customEndDatestring | nullCustom end date (YYYY-MM-DD)
data[].diagnosestring | nullDiagnosis
data[].reasonstring | nullReason
data[].bedrestboolean | nullBed rest ordered
data[].curfew1StartTimestring | nullStart of 1st curfew period (HH:MM)
data[].curfew1EndTimestring | nullEnd of 1st curfew period (HH:MM)
data[].curfew2StartTimestring | nullStart of 2nd curfew period (HH:MM)
data[].curfew2EndTimestring | nullEnd of 2nd curfew period (HH:MM)
data[].hospitalCareStartTimestring | nullHospital care start time (HH:MM)
data[].hospitalCareEndTimestring | nullHospital care end time (HH:MM)
data[].hospitalCareStartDatestring | nullHospital care start date (YYYY-MM-DD)
data[].hospitalCareEndDatestring | nullHospital care end date (YYYY-MM-DD)
data[].occupationalDiseaseinteger | nullOccupational disease (0 = no)
data[].electricalAccidentboolean | nullElectrical accident
data[].reorderDate1string | null1st follow-up appointment (YYYY-MM-DD)
data[].reorderDate2string | null2nd follow-up appointment (YYYY-MM-DD)
data[].reorderDate3string | null3rd follow-up appointment (YYYY-MM-DD)
data[].reasonForBackdatingstring | nullReason for backdating
data[].specialIllnessReasonstring | nullReason for special illness
data[].noticeForInsurancestring | nullNotice for insurance
data[].printedboolean | nullAlready printed
data[].customerobject | nullAssigned customer
data[].customer.idstring (UUID)Customer ID
data[].customer.firstNamestringFirst name
data[].customer.lastNamestringLast name
meta.totalintegerTotal number of health notifications
meta.offsetintegerCurrent start position
meta.limitintegerNumber of returned entries
Beispiele
bash
curl -X GET "https://my.offisy.at/api/oauth/v2/resource/health-notifications?offset=0&limit=50" \
  -H "Authorization: Bearer {access_token}"
Parameter
Zuerst Token anfordern

Possible errors

StatusCodeDescription
401invalid_clientInvalid or missing access token
403insufficient_scopeScope medicals not present

Offisy GmbH