Skip to content

List visit confirmations

Returns a paginated list of all visit confirmations of the company.

Request

GET /api/oauth/v2/resource/visit-confirmations

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",
      "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"
      }
    },
    {
      "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "customDate": "2026-06-08",
      "customStart": null,
      "customEnd": null,
      "printTime": false,
      "printed": true,
      "customer": {
        "id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
        "firstName": "Thomas",
        "lastName": "Gruber"
      }
    }
  ],
  "meta": {
    "total": 18,
    "offset": 0,
    "limit": 50
  }
}

Response fields

FieldTypeDescription
dataArrayList of visit confirmations
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
meta.totalintegerTotal number of visit confirmations
meta.offsetintegerCurrent start position
meta.limitintegerNumber of returned entries
Beispiele
bash
curl -X GET "https://my.offisy.at/api/oauth/v2/resource/visit-confirmations?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