Skip to content

List customer notices

Returns a paginated list of all customer notices for the company.

Request

GET /api/oauth/v2/resource/customer-notices

HeaderValue
AuthorizationBearer {access_token}

Query parameters

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

Response

Success (200 OK)

json
{
  "data": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "text": "Patient prefers morning appointments.",
      "customDate": "2026-06-08",
      "customer": {
        "id": "f0e1d2c3-b4a5-6789-fedc-ba9876543210",
        "firstName": "Anna",
        "lastName": "Muster"
      },
      "treatingUser": {
        "id": "d4c5b6a7-8901-2345-6789-0abcdef12345",
        "firstName": "Maria",
        "lastName": "Muster",
        "abbreviation": "MM"
      }
    }
  ],
  "meta": {
    "total": 84,
    "offset": 0,
    "limit": 50
  }
}

Response fields

FieldTypeDescription
dataArrayList of customer notices
data[].idstring (UUID)Unique note ID
data[].textstringNote text (decrypted)
data[].customDatestring | nullDate set by the user for the note (YYYY-MM-DD)
data[].customerobject | nullAssigned customer
data[].customer.idstring (UUID)Customer ID
data[].customer.firstNamestring | nullFirst name
data[].customer.lastNamestring | nullLast name
data[].treatingUserobject | nullTreating staff member
data[].treatingUser.idstring (UUID)User ID
data[].treatingUser.firstNamestringFirst name
data[].treatingUser.lastNamestringLast name
data[].treatingUser.abbreviationstring | nullUser's abbreviation
meta.totalintegerTotal number of customer notices
meta.offsetintegerCurrent start position
meta.limitintegerNumber of returned entries
Beispiele
bash
curl -X GET "https://my.offisy.at/api/oauth/v2/resource/customer-notices?offset=0&limit=50" \
  -H "Authorization: Bearer {access_token}"
Parameter
Zuerst Token anfordern

Possible errors

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

Offisy GmbH