CalendarEvent

Get a specific calendar event.

Changed on

Get a specific calendar event by its id.<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/{id}

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

Path parameters

idstring required

The id of the calendar event.

Query parameters

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.

idstring required

The id of the calendar event.

titlestring required

The title of the calendar event.

descriptionstring nullable

The description of the calendar event.

fromstring date required

The first date the calendar event takes place.

tostring date required

The last date the calendar event takes place.

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

The category of the calendar event.

propertyIdsstring[] required

The ids of the properties this calendar event currently applies to. Sorted A–Z by property code.

Example response

{
  "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
  }
}

Changes