--- title: "Generates the calendar that we draw events on" method: GET path: "/schedule/data/events" tags: ["schedule"] --- # Generates the calendar that we draw events on `GET /schedule/data/events` ## Query parameters - `displayGroupIds` integer[], required - `from` string - `to` string ## Response `200` successful response - ScheduleCalendarData[] - `id` integer — Event ID - `title` string — Event Title - `sameDay` integer — Does this event happen only on 1 day - `event` Schedule - `eventId` integer — The ID of this Event - `eventTypeId` integer — The Event Type ID - `campaignId` integer — The CampaignID this event is for - `commandId` integer — The CommandId this event is for - `displayGroups` DisplayGroup[] — Display Groups assigned to this Scheduled Event. - `displayGroupId` integer — The displayGroup Id - `displayGroup` string — The displayGroup Name - `description` string — The displayGroup Description - `isDisplaySpecific` integer — A flag indicating whether this displayGroup is a single display displayGroup - `isDynamic` integer — A flag indicating whether this displayGroup is dynamic - `dynamicCriteria` string — Criteria for this dynamic group. A comma separated set of regular expressions to apply - `dynamicCriteriaLogicalOperator` string — Which logical operator should be used when filtering by multiple dynamic criteria? OR|AND - `dynamicCriteriaTags` string — Criteria for this dynamic group. A comma separated set of tags to apply - `dynamicCriteriaExactTags` integer — Flag indicating whether to filter by exact Tag match - `dynamicCriteriaTagsLogicalOperator` string — Which logical operator should be used when filtering by multiple Tags? OR|AND - `userId` integer — The UserId who owns this display group - `tags` TagLink[] — Tags associated with this Display Group, array of TagLink objects - `tag` string — The Tag - `tagId` integer — The Tag ID - `value` string — The Tag Value - `bandwidthLimit` integer — The display bandwidth limit - `groupsWithPermissions` string — A comma separated list of groups/users with permissions to this DisplayGroup - `createdDt` string — The datetime this entity was created - `modifiedDt` string — The datetime this entity was last modified - `folderId` integer — The id of the Folder this Display Group belongs to - `permissionsFolderId` integer — The id of the Folder responsible for providing permissions for this Display Group - `ref1` string — Optional Reference 1 - `ref2` string — Optional Reference 2 - `ref3` string — Optional Reference 3 - `ref4` string — Optional Reference 4 - `ref5` string — Optional Reference 5 - `scheduleReminders` ScheduleReminder[] — Schedule Reminders assigned to this Scheduled Event. - `scheduleReminderId` integer — Schedule Reminder ID - `eventId` integer — The event ID of the schedule reminder - `value` integer — An integer number to define minutes, hours etc. - `type` integer — The type of the reminder (i.e. Minute, Hour, Day, Week, Month) - `option` integer — The options regarding sending a reminder for an event. (i.e., Before start, After start, Before end, After end) - `isEmail` integer — Email flag for schedule reminder - `reminderDt` integer — A date that indicates the reminder date - `lastReminderDt` integer — Last reminder date a reminder was sent - `criteria` ScheduleCriteria[] — Schedule Criteria assigned to this Scheduled Event. - unknown - `userId` integer — The userId that owns this event. - `fromDt` integer — A Unix timestamp representing the from date of this event in CMS time. - `toDt` integer — A Unix timestamp representing the to date of this event in CMS time. - `isPriority` integer — Integer indicating the event priority. - `displayOrder` integer — The display order for this event. - `recurrenceType` 'None' | 'Minute' | 'Hour' | 'Day' | 'Week' | 'Month' | 'Year' — If this event recurs when what is the recurrence period. - `recurrenceDetail` integer — If this event recurs when what is the recurrence frequency. - `recurrenceRange` integer — A Unix timestamp indicating the end time of the recurring events. - `recurrenceRepeatsOn` string — Recurrence repeats on days - 0 to 7 where 0 is a monday - `recurrenceMonthlyRepeatsOn` integer — Recurrence monthly repeats on - 0 is day of month, 1 is weekday of week - `campaign` string — The Campaign/Layout Name - `command` string — The Command Name - `dayPartId` integer — The Day Part Id - `isAlways` integer — Is this event an always on event? - `isCustom` integer — Does this event have custom from/to date times? - `syncEvent` integer — Flag indicating whether the event should be synchronised across displays - `syncTimezone` integer — Flag indicating whether the event will sync to the Display timezone - `shareOfVoice` integer — Seconds (0-3600) of each full hour that is scheduled that this Layout should occupy - `maxPlaysPerHour` integer — The maximum number of plays per hour per display for this event - `isGeoAware` integer — Flag (0-1), whether this event is using Geo Location - `geoLocation` string — Geo JSON representing the area of this event - `actionTriggerCode` string — For Action event type, Action trigger code - `actionType` string — For Action event type, the type of the Action (navigate to Layout or Command) - `actionLayoutCode` string — For Action event type and navigate to Layout Action type, the Layout code - `parentCampaignId` integer — If the schedule should be considered part of a larger campaign - `syncGroupId` integer — For sync events, the id the the sync group - `dataSetId` integer — For data connector events, the dataSetId - `dataSetParams` integer — For data connector events, the data set parameters - `modifiedBy` integer — The userId of the user that last modified this Schedule - `createdOn` string — The Date this Schedule was created on - `updatedOn` string — The Date this Schedule was las updated on - `name` string — The name of this Scheduled Event ## Changes - **2022-11-08** `91bf308f1ecd` — 1 breaking, 2 info - the `query` request parameter `displayGroupIds` became required - the `query` request parameter `from` became optional - the `query` request parameter `to` became optional - **2020-02-17** `8e1275395104` — 3 breaking, 2 info - the `query` request parameter `from` became required - the `query` request parameter `to` became required - removed the media type `application/json` for the response with the status `200` - endpoint reactivated - …1 more [Change history](https://skmtc.dev/xibosignage/apis/xibo-api/changes/schedule/data/events/get.md) --- [API](https://skmtc.dev/xibosignage/apis/xibo-api.md) · [All operations](https://skmtc.dev/xibosignage/apis/xibo-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/xibosignage/xibo-api/revisions/fa8d95dfe4bb/schema)