---
title: "Gets schedules in an account."
method: GET
path: "/schedules"
tags: ["Schedules"]
---

# Gets schedules in an account.

`GET /schedules`

## Query parameters

- `id` string
- `take` integer
- `page` integer
- `group_id` string[]
- `group_name` string[]
- `device_id` string

## Response `200`

OK

- Schedule[]
  - `name` string, nullable — The name of the schedule
  - `group_id` string, nullable — The group id to which the schedule belongs
  - `tags` string, nullable — The tags associated with the schedule
  - `monday` boolean, nullable — Enabled this schedule for playback on Monday. Only applicable for Playlist and Template schedules.
  - `tuesday` boolean, nullable — Enabled this schedule for playback on Tuesday. Only applicable for Playlist and Template schedules.
  - `wednesday` boolean, nullable — Enabled this schedule for playback on Wednesday. Only applicable for Playlist and Template schedules.
  - `thursday` boolean, nullable — Enabled this schedule for playback on Thursday. Only applicable for Playlist and Template schedules.
  - `friday` boolean, nullable — Enabled this schedule for playback on Friday. Only applicable for Playlist and Template schedules.
  - `saturday` boolean, nullable — Enabled this schedule for playback on Saturday. Only applicable for Playlist and Template schedules.
  - `sunday` boolean, nullable — Enabled this schedule for playback on Sunday. Only applicable for Playlist and Template schedules.
  - `start_date` string, nullable — The start date for the schedule. Only applicable for Playlist and Template schedules.
  - `end_date` string, nullable — The end date for the schedule. Only applicable for Playlist and Template schedules.
  - `start_time` string, nullable — The start time for the schedule. Only applicable for Playlist and Template schedules.
  - `end_time` string, nullable — The end time for the schedule. Only applicable for Playlist and Template schedules.
  - `template_id` string, nullable — The template id for the schedule. Only applicable for Playlist and Template schedules.
  - `playlist_id` string, nullable — The playlist id for the schedule. Only applicable for Playlist and Template schedules.
  - `type` 'Playlist' | 'Template' | 'Campaign' — The following schedule types are available: - Playlist Playlist is considered a basic schedule consisting of a single playlist with a date range, time range, and days of the week. Schedule properties to consider when using this type include the following: start_date, end_date, start_time, end_time, playlist_id, and monday-sunday - Template Template is considered a basic schedule consisting of a single template with a date range, time range, and days of the week. Schedule properties to consider when using this type include the following: start_date, end_date, start_time, end_time, template_id, and monday-sunday - Campaign Campaign schedules, or 'Smart Schedules', are more advanced consisting of multiple conditions logically grouped to determine what, when, and where content is played. Schedule properties to consider when using this type include an array of conditions.
  - `devices` ScheduleDevice[], nullable — The devices associated with the schedule.
    - `id` string, nullable — The device id
  - `conditions` Condition[], nullable — The conditions associated with the schedule. Only applicable for Campaign schedules.
    - `type` 'AfterDate' | 'AfterTime' | 'Always' | 'BeaconActive' | 'BeforeDate' | 'BeforeTime' | 'Command' | 'DateRange' | 'DayOfMonth' | 'DaysOfWeek' | 'DeviceByGroup' | 'DeviceByNestedGroup' | 'DeviceByName' | 'DeviceByTag' | 'DeviceByOrg' | 'Everywhere' | 'GeoLocation' | 'GpsWithinRadius' | 'KeyEvent' | 'MonthOfYear' | 'Motion' | 'Never' | 'Nowhere' | 'PctAdult' | 'PctChild' | 'PctFemale' | 'PctMale' | 'PctSenior' | 'PctYoung' | 'PctYoungAdult' | 'PlaylistByName' | 'PlaylistByTag' | 'SendCommand' | 'SpecificDevice' | 'SpecificPlaylist' | 'SpecificTemplate' | 'SpecificZone' | 'TemplateByName' | 'TemplateByTag' | 'TimeRange' | 'TopicSet' | 'TotalViewersGreaterThan' | 'TotalViewersLessThan' | 'TouchEvent' | 'WeekOfMonth' | 'WeekOfYear' — The following enum represents the different types of conditions that can be used in scheduling logic. Important usage notes specific to ConditionType: - ConditionType: "TimeRange" Value1: "01/01/1970 12:00:00 AM" # Start time. Starts at this time. Date/time format: "MM/dd/yyyy hh:mm:ss aa" Value2: "01/01/1970 12:00:00 AM" # End time. Stops at this time. Date/time format: "MM/dd/yyyy hh:mm:ss aa" Value3: null Value4: null - ConditionType: "TopicSet" Value1: "sports,news,weather" # Comma separted list of topics Value2: null Value3: null Value4: null - ConditionType: "TotalViewersGreaterThan" Value1: "50" Value2: null Value3: null Value4: null - ConditionType: "TotalViewersLessThan" Value1: "100" Value2: null Value3: null Value4: null - ConditionType: "TouchEvent" Value1: "tap" Value2: "screen1" Value3: null Value4: null - ConditionType: "WeekOfMonth" Value1: "2" Value2: null Value3: null Value4: null - ConditionType: "WeekOfYear" Value1: "25" Value2: null Value3: null Value4: null - ConditionType: "GpsWithinRadius" Value1: "40.7128" Value2: "-74.0060" Value3: "50" Value4: "miles" - ConditionType: "KeyEvent" Value1: "ENTER" Value2: null Value3: null Value4: null - ConditionType: "MonthOfYear" Value1: "12" Value2: null Value3: null Value4: null - ConditionType: "Motion" Value1: "detected" Value2: "5" Value3: null Value4: null - ConditionType: "Never" Value1: null Value2: null Value3: null Value4: null - ConditionType: "PctAdult" Value1: "60" Value2: ">=" Value3: null Value4: null - ConditionType: "PctChild" Value1: "25" Value2: "<=" Value3: null Value4: null - ConditionType: "PctFemale" Value1: "40" Value2: ">=" Value3: null Value4: null - ConditionType: "PctMale" Value1: "60" Value2: "<=" Value3: null Value4: null - ConditionType: "PctSenior" Value1: "15" Value2: ">=" Value3: null Value4: null - ConditionType: "PctYoung" Value1: "30" Value2: "<=" Value3: null Value4: null - ConditionType: "PctYoungAdult" Value1: "35" Value2: ">=" Value3: null Value4: null - ConditionType: "AfterDate" Value1: "01/01/1970 12:00:00 AM" # Date/time format: "MM/dd/yyyy hh:mm:ss aa" Value2: null Value3: null Value4: null - ConditionType: "AfterTime" Value1: "01/01/1970 12:00:00 AM" # Date/time format: "MM/dd/yyyy hh:mm:ss aa" Value2: null Value3: null Value4: null - ConditionType: "Always" Value1: null Value2: null Value3: null Value4: null - ConditionType: "BeaconActive" Value1: "Beacon Name" # Name of the beacon Value2: "UUID / Namespace" # UUID or Namespace identifier Value3: "Major / Instance" # Major ID or Instance identifier Value4: "Minor" # Minor ID - ConditionType: "BeforeDate" Value1: "01/01/1970 12:00:00 AM" # Date/time format: "MM/dd/yyyy hh:mm:ss aa" Value2: null Value3: null Value4: null - ConditionType: "BeforeTime" Value1: "01/01/1970 12:00:00 AM" # Date/time format: "MM/dd/yyyy hh:mm:ss aa" Value2: null Value3: null Value4: null - ConditionType: "Command" Value1: "Command Name" Value2: "Command Arg" Value3: null Value4: null - ConditionType: "DateRange" Value1: "01/01/1970 12:00:00 AM" # Start date. Starts ON this date. Date/time format: "MM/dd/yyyy hh:mm:ss aa" Value2: "01/01/1970 12:00:00 AM" # End date. Stops AFTER this date. Date/time format: "MM/dd/yyyy hh:mm:ss aa" Value3: null Value4: null - ConditionType: "DayOfMonth" Value1: "15" Value2: null Value3: null Value4: null - ConditionType: "DaysOfWeek" Value1: "10" # Integer Bitfield starting with Sunday as the least significant bit Value2: null Value3: null Value4: null - ConditionType: "DeviceByGroup" # Selects all devices in a group by the groups unique identifier Value1: 0 # Unique device group ID Value2: null Value3: null Value4: null - ConditionType: "DeviceByName" # Selects a device by its name. Supports regular expressions for advanced matching Value1: "Device Name" # Supports regular expressions Value2: null Value3: null Value4: null - ConditionType: "DeviceByNestedGroup" # Selects all devices in a group by the groups unique identifier. Includes all devices in this group and all nested groups Value1: 0 # Unique device group ID Value2: null Value3: null Value4: null - ConditionType: "DeviceByOrg" # Selects all devices in an organization Value1: 0 # Unique organization ID Value2: null Value3: null Value4: null - ConditionType: "DeviceByTag" # Selects devices by their associated tags Value1: "critical_infrastructure" # Newline separted list of tags Value2: null Value3: null Value4: null - ConditionType: "Everywhere" Value1: null Value2: null Value3: null Value4: null - ConditionType: "GeoLocation" Value1: "37.7749" # Latitude of the location Value2: "-122.4194" # Longitude of the location Value3: "50" # Distance in miles from geolocation" Value4: "123 5th St. N" # Street address of the location - ConditionType: "Nowhere" Value1: null Value2: null Value3: null Value4: null - ConditionType: "SpecificDevice" Value1: 0 # Unique device ID Value2: null Value3: null Value4: null
    - `operator` 'And' | 'Or' | 'AndNot' | 'OrNot'
    - `value_1` string, nullable — Value 1. See ConditionType documentation for usage notes.
    - `value_2` string, nullable — Value 2. See ConditionType documentation for usage notes.
    - `value_3` string, nullable — Value 3. See ConditionType documentation for usage notes.
    - `value_4` string, nullable — Value 4. See ConditionType documentation for usage notes.
  - `priority` 'Normal' | 'High' | 'Highest' | 'Lowest' | 'Low'
  - `id` string, nullable — The schedule id
  - `group_name` string, nullable — The name of the group to which the schedule belongs
  - `created_on` string, date-time, nullable — The date the schedule was created
  - `created_by_id` string, nullable — The user id that created the schedule
  - `modified_on` string, date-time, nullable — The date the schedule was last modified
  - `modified_by_id` string, nullable — The user id that last modified the schedule

---

[API](https://skmtc.net/reveldigital/apis/revel-digital-rest-api.md) · [All operations](https://skmtc.net/reveldigital/apis/revel-digital-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/reveldigital/revel-digital-rest-api/versions/f23a94aea621/schema)