Skip to content

Get visit confirmation

Returns the details of a single visit confirmation.

Request

GET /api/oauth/v2/resource/visit-confirmations/{uuid}

HeaderValue
AuthorizationBearer {access_token}

URL parameters

ParameterTypeRequiredDescription
uuidstringYesUnique ID of the visit confirmation

Response

Success (200 OK)

json
{
  "data": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "customDate": "2026-06-09",
    "customStart": "09:00",
    "customEnd": "09:30",
    "printTime": true,
    "printed": false,
    "customer": {
      "id": "f0e1d2c3-b4a5-6789-fedc-ba9876543210",
      "firstName": "Anna",
      "lastName": "Muster"
    }
  }
}

Response fields

FieldTypeDescription
data.idstring (UUID)Unique ID of the visit confirmation
data.customDatestring | nullDate of the visit (YYYY-MM-DD)
data.customStartstring | nullStart time of the visit (HH:MM)
data.customEndstring | nullEnd time of the visit (HH:MM)
data.printTimeboolean | nullPrint time on the confirmation
data.printedboolean | nullConfirmation has already been printed
data.customerobject | nullAssigned customer
data.customer.idstring (UUID)Customer ID
data.customer.firstNamestringCustomer first name
data.customer.lastNamestringCustomer last name
Beispiele
bash
curl -X GET "https://my.offisy.at/api/oauth/v2/resource/visit-confirmations/b2c3d4e5-f6a7-8901-bcde-f01234567890" \
  -H "Authorization: Bearer {access_token}"
Parameter
Zuerst Token anfordern

Possible errors

StatusCodeDescription
401invalid_clientInvalid or missing access token
403insufficient_scopeScope medicals not present
404not_foundVisit confirmation not found

Offisy GmbH