List Calendars

Return a list of all calendars for an organization

A calendar is the top level container for Scheduling configurations, which represents a Calendar.

Calendar Fields

ParameterData TypeDescription
activebooleanWhen active is true, the calendar may be used for notifications. Otherwise, it is only visible to define a schedule.
emailNotificationEnabledbooleanIf true, alerts are sent for changes made to the calendar.
emailNotificationListarrayA distribution list to receive change notifications.
externalIdstringA client defined ID for mapping to external resources.
icalUIDstringIf created using ical import, a reference to the ical UID which generated this resource.
namestringThe name of the Calendar.
notifyScheduledbooleanIf true, staff impacted by configuration changes will receive change notifications.
statusstringIndicates whether the resource is active or deleted.
typestringThe name of the Resource (constant).
visibilitystringDefines whether the calendar is visible to the organization or only to those staffed to the calendar.

Return type

Calendar Object

Parameters

NameRequired?Data TypeParameters
organizationIdylongThe ID of the organization that owns this resource.
holidayCalendarCodesnarray of stringsAn array containing country codes for the countries/regions to which this calendar is related. No validation is done. Invalid codes will be ignored.
Language
Credentials
URL
Click Try It! to start a request and see the response here!