APapaleo
CalendarEvent

Get a list of calendar events.

Changed on

Get every calendar event whose property ids intersect the properties the caller can access, optionally narrowed further by the given request.<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

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
  • Auth
    OAuth 2
    Implicit: https://identity.apaleo.com/connect/authorize
    Scopes: calendar-events.read, admin

Query parameters

propertyIdsstring[]

Return calendar events touching any of the specified property ids.

category'ConcertsAndMusic' | 'Sports' | 'ArtsAndEntertainment' | 'ConferencesAndBusiness' | 'CommunityAndLifestyle' | 'PublicHoliday' | 'SchoolHoliday' | 'Other'

Return calendar events of the specified category.

pageNumberinteger

Page number to retrieve. Default: 1. If the page has no items, the API returns 204 No Content.

pageSizeinteger

Items per page. Default: 500. Maximum: 500.

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

{
  "calendarEvents": [
    {
      "id": "ZDGUUAKX",
      "title": "Oktoberfest",
      "description": "Munich's yearly beer festival",
      "from": "2026-09-19",
      "to": "2026-10-04",
      "category": "CommunityAndLifestyle",
      "propertyIds": [
        "MUC"
      ],
      "recurrence": {
        "frequency": "Yearly",
        "interval": 1
      }
    }
  ],
  "count": 1
}

Changes