Get what a channel plays

GET

https://api.fastpix.com/v1/cloud-playout/channels/:channelId/schedule

GET

/v1/cloud-playout/channels/:channelId/schedule

curl -G https://api.fastpix.com/v1/cloud-playout/channels/cc99cae6-56b4-46ab-9f4a-8b2462d8137c/schedule \
     -u "<username>:<password>" \
     -d type=loop

200Retrieved

{
  "success": true,
  "data": {
    "schedule": [
      {
        "id": "9d9f2c67-0a25-4b3e-9a70-1a5c1d2b6f88",
        "name": "Ad break intro",
        "type": "bumper",
        "startTime": "2026-09-02T17:59:55Z",
        "endTime": "2026-09-02T18:00:00Z",
        "duration": "00:00:05",
        "bumperId": "9d9f2c67-0a25-4b3e-9a70-1a5c1d2b6f88",
        "bumperName": "Ad break intro",
        "programId": "d85083a0-e935-4c29-9c32-6720bdc9b22f",
        "programName": "Morning block"
      },
      {
        "id": "8c2c4ef1-1c2a-4a49-9c5b-8f9c0a7c3d21",
        "name": "Morning headlines",
        "type": "vod",
        "startTime": "2026-09-02T18:00:00Z",
        "endTime": "2026-09-02T18:10:30Z",
        "duration": "00:10:30",
        "thumbnail": "https://images.fastpix.com/8c2c4ef1-1c2a-4a49-9c5b-8f9c0a7c3d21/thumbnail.png",
        "sourceResolution": "1080p",
        "programId": "d85083a0-e935-4c29-9c32-6720bdc9b22f",
        "programName": "Morning block",
        "programMediaId": "4a1e1f3b-2c0d-4c4a-9a02-1d7e5f6b8c90"
      }
    ],
    "videoCount": 2
  }
}

This endpoint returns what a Cloud Playout channel plays and when, as a flat timeline. It works for both channel types, and is the endpoint to use when you want the actual running order rather than the configuration behind it.

How it works

Make a GET request to this endpoint with the channelId and the channel’s type.
The response returns the timeline in play order, with every entry carrying its own startTime, endTime and duration.
Narrow the response to a period with startTime and endTime.

For a loop channel the programs are expanded into the times they actually play, pass after pass, so an item that comes round four times appears four times. Bumpers appear as entries of their own, in the place they play, carrying bumperId and bumperName.

For a schedule channel the bumpers belong to the event instead, and are returned in the entry’s bumper object rather than as entries of their own.

Example

A channel guide shows viewers what is on now and next by asking for the timeline between now and two hours ahead.

Authentication

AuthorizationBasic

FastPix APIs are secured with Basic Authentication. Use your Access Token ID as the username and Secret Key as the password in the Authorization header of each API request.

Username: Access Token ID
Password: Secret Key

Activate your FastPix account to generate your API credentials. See the guide here

Path parameters

channelIdstringRequiredformat: "uuid"

The unique identifier of the channel whose timeline is retrieved.

Query parameters

typeenumRequired

The type of the channel. It must match the channel's own type.

Allowed values:

startTimestringOptional

Only return what plays at or after this time, in yyyy-MM-dd'T'HH:mm:ss format and interpreted as UTC.

endTimestringOptional

Only return what plays at or before this time, in yyyy-MM-dd'T'HH:mm:ss format and interpreted as UTC. It must be later than startTime.

Response

Channel timeline retrieved successfully

successbooleanOptional

Shows the request status. Returns true for success and false for failure.

dataobjectOptional