APapaleo
CalendarEvent

Get calendar event occurrences.

Changed on

Get every expanded occurrence that overlaps the given date range for the properties the caller can access. Recurrence is expanded and cancelled slots are omitted. textSearch narrows to events where every word of this text is a case-insensitive prefix of a word in the title or the description. A hyphenated word also matches when each of its parts is a prefix of some word.<br>You must have this scope: 'calendar-events.read'.<br>For fine-grained clients, you must have this permission: 'core.calendar_events.read'.

get/calendar/v0-nsfw/events/occurrences

Request

  • Base URL
    https://api.apaleo.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.apaleo.com/calendar/v0-nsfw/events/occurrences
  • Auth
    OAuth 2
    Implicit: https://identity.apaleo.com/connect/authorize
    Scopes: calendar-events.read, admin

Query parameters

propertyIdsstring[]

Return occurrences touching any of the specified property ids.

fromstring date required

Inclusive local start date of the query window.

tostring date required

Inclusive local end date of the query window.

categoriesstring[]

Return occurrences of any of the specified categories.

eventIdsstring[]

Return occurrences of the specified event ids. Unknown ids contribute nothing.

textSearchstring

Return occurrences of events where every word of this text is a case-insensitive prefix of a word in the title or the description. A hyphenated word also matches when each of its parts is a prefix of some word.

expandstring[]

List of all embedded resources that should be expanded in the response. Possible values are: actions. All other values will be silently ignored.

Response

Success.

countinteger required

Total count of items

Example response

{
  "occurrences": [
    {
      "eventId": "ZDGUUAKX",
      "propertyIds": [
        "MUC1",
        "VIE1"
      ],
      "title": "Oktoberfest",
      "description": "Munich's yearly beer festival",
      "category": "CommunityAndLifestyle",
      "from": "2026-09-19",
      "to": "2026-10-04",
      "originalEvent": {
        "from": "2026-09-19",
        "to": "2026-10-04"
      },
      "isShared": true,
      "recurrence": {
        "frequency": "Weekly",
        "interval": 1,
        "end": "2026-10-03"
      }
    }
  ],
  "count": 1
}

Changes