Skip to content
Tilecast Docs

getSchedule

GET
/api/v1/schedules/{id}
curl --request GET \
  --url https://example.com/api/v1/schedules/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --cookie tilecast_session=<tilecast_session>

Get schedule. Requires an authenticated dashboard user.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid

Responses

Section titled “ Responses ”

200

Section titled “200”

Schedule and normalized targets

Media typeapplication/json
object
data
required
object
id
required
string format: uuid
name
required
string
description
required
string
playlistId
string format: uuid
playlistName
required
string
layoutId
string format: uuid
layoutName
string
presentationType
required
string
Allowed values: playlist layout display_control
type
required
string
Allowed values: one_time weekly
timezone
required
string
priority
required
integer
>= -999 <= 999
specificity
required
integer
enabled
required
boolean
startDate
string format: date
endDate
string format: date
oneTimeStart
string format: date-time
oneTimeEnd
string format: date-time
dailyStart
string
dailyEnd
string
daysOfWeek
required
Array<integer>
displayAction

A bounded Display Control action. A schedule may contain one action instead of a playlist or Layout. The server validates that only the field belonging to the selected type is present.

object
type
required
string
Allowed values: display_power_on display_power_off display_set_input display_set_volume display_mute display_unmute display_set_brightness
input
string
/^[A-Za-z0-9._:-]{1,32}$/
volume
integer
<= 100
brightness
integer
<= 100
targets
required
Array<object>
object
type
required
string
Allowed values: screen group
id
required
string format: uuid
name
string
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
Example
{
  "data": {
    "presentationType": "playlist",
    "type": "one_time",
    "displayAction": {
      "type": "display_power_on"
    },
    "targets": [
      {
        "type": "screen"
      }
    ]
  }
}