Skip to content
Tilecast Docs

listSchedules

GET
/api/v1/schedules
curl --request GET \
  --url 'https://example.com/api/v1/schedules?enabled=true&type=weekly&presentationType=playlist&sort=updated' \
  --cookie tilecast_session=<tilecast_session>

Requires an authenticated user with the read scope. Schedule list with optional search, facet filters, sort, and pagination. Every parameter is optional; a value outside its closed set is rejected with 400. The reported total describes the filtered result, not the whole library. Every sort is deterministic, ending in the schedule id.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters”
search
string
enabled
string
Allowed values: true false

Only enabled or only disabled schedules.

type
string
Allowed values: weekly one_time

Only weekly or only one-time schedules.

presentationType
string
Allowed values: playlist layout display_control

Only schedules that present this kind of content or action.

sort
string
Allowed values: updated name priority

Updated is most recently updated first (the default), name is case-insensitive A to Z, and priority is highest priority first, with the most recently updated first among equals.

page
integer
>= 1
pageSize
integer
>= 1 <= 100

Responses

Section titled “ Responses ”

200

Section titled “200”

Paginated schedules

Media typeapplication/json
object
data
required
object
items
required
Array<object>
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
total
required
integer
page
required
integer
>= 1
pageSize
required
integer
>= 1
defaultTimezone
required
string
Example
{
  "data": {
    "items": [
      {
        "presentationType": "playlist",
        "type": "one_time",
        "displayAction": {
          "type": "display_power_on"
        },
        "targets": [
          {
            "type": "screen"
          }
        ]
      }
    ]
  }
}

400

Section titled “400”

A filter or sort value is not recognized

401

Section titled “401”

Dashboard authentication required