Sign in

v1

latestOpenAPI 3.0.42026-08-06124112344.5 KB
Schedules

Gets schedules in an account.

get/schedules

Query parameters

idstring

Optional schedule Id to filter by

takeinteger

Optional number of items to return

pageinteger

Optional number of page to return

group_idstring[]

Optional schedule group Id

group_namestring[]

Optional group name to filter by

device_idstring

Optional schedule Id to filter by

Response

OK

namestring nullable

The name of the schedule

group_idstring nullable

The group id to which the schedule belongs

tagsstring nullable

The tags associated with the schedule

mondayboolean nullable

Enabled this schedule for playback on Monday. Only applicable for Playlist and Template schedules.

tuesdayboolean nullable

Enabled this schedule for playback on Tuesday. Only applicable for Playlist and Template schedules.

wednesdayboolean nullable

Enabled this schedule for playback on Wednesday. Only applicable for Playlist and Template schedules.

thursdayboolean nullable

Enabled this schedule for playback on Thursday. Only applicable for Playlist and Template schedules.

fridayboolean nullable

Enabled this schedule for playback on Friday. Only applicable for Playlist and Template schedules.

saturdayboolean nullable

Enabled this schedule for playback on Saturday. Only applicable for Playlist and Template schedules.

sundayboolean nullable

Enabled this schedule for playback on Sunday. Only applicable for Playlist and Template schedules.

start_datestring nullable

The start date for the schedule. Only applicable for Playlist and Template schedules.

end_datestring nullable

The end date for the schedule. Only applicable for Playlist and Template schedules.

start_timestring nullable

The start time for the schedule. Only applicable for Playlist and Template schedules.

end_timestring nullable

The end time for the schedule. Only applicable for Playlist and Template schedules.

template_idstring nullable

The template id for the schedule. Only applicable for Playlist and Template schedules.

playlist_idstring 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.

priority'Normal' | 'High' | 'Highest' | 'Lowest' | 'Low'
idstring nullable

The schedule id

group_namestring nullable

The name of the group to which the schedule belongs

created_onstring date-time nullable

The date the schedule was created

created_by_idstring nullable

The user id that created the schedule

modified_onstring date-time nullable

The date the schedule was last modified

modified_by_idstring nullable

The user id that last modified the schedule