get https://api.everbridge.net/rest/scheduling//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
Parameter | Data Type | Description |
---|---|---|
active | boolean | When active is true, the calendar may be used for notifications. Otherwise, it is only visible to define a schedule. |
emailNotificationEnabled | boolean | If true, alerts are sent for changes made to the calendar. |
emailNotificationList | array | A distribution list to receive change notifications. |
externalId | string | A client defined ID for mapping to external resources. |
icalUID | string | If created using ical import, a reference to the ical UID which generated this resource. |
name | string | The name of the Calendar. |
notifyScheduled | boolean | If true, staff impacted by configuration changes will receive change notifications. |
status | string | Indicates whether the resource is active or deleted. |
type | string | The name of the Resource (constant). |
visibility | string | Defines whether the calendar is visible to the organization or only to those staffed to the calendar. |
Return type
Calendar Object
Parameters
Name | Required? | Data Type | Parameters |
---|---|---|---|
organizationId | y | long | The ID of the organization that owns this resource. |
holidayCalendarCodes | n | array of strings | An array containing country codes for the countries/regions to which this calendar is related. No validation is done. Invalid codes will be ignored. |