> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://fastpix.com/docs/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://fastpix.com/docs/_mcp/server.

# Get the events on a schedule channel

GET https://api.fastpix.com/v1/cloud-playout/channels/{id}/schedule-event

This endpoint retrieves the events scheduled on a Cloud Playout schedule channel, in the order they play. The `id` in the path is the channel's ID.

#### How it works

1. Make a GET request to this endpoint with the `channelId`.

2. The response returns each event with its type, what it plays, when it runs, and any bumpers attached to it.

3. Narrow the response to a period with `startTime` and `endTime`. Leave both out to get the whole timeline.

Events are returned in full, without pagination.

#### Example

A playout dashboard loads tomorrow's line-up for a channel by asking for the events between midnight and midnight.


Reference: https://fastpix.com/docs/cloud-playout-api/schedule-channel/get-cloud-playout-schedule-channel-events

## Authentication

- `Authorization` header (basic auth, required) — 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

## Request

### Path parameters

- `id` (string, required) — The unique identifier of the schedule channel whose events are retrieved.

### Query parameters

- `startTime` (string, optional) — Only return events at or after this time, in `yyyy-MM-dd'T'HH:mm:ss` format and interpreted as UTC.
- `endTime` (string, optional) — Only return events at or before this time, in `yyyy-MM-dd'T'HH:mm:ss` format and interpreted as UTC. It can be sent on its own to return everything up to that point.

## Response

### 200

Schedule channel events retrieved successfully

- `success` (boolean, optional) — Shows the request status. Returns true for success and false for failure.
- `data` (list of CloudPlayoutScheduleEvent, optional) — The events on the channel, in the order they play.

## Types

### CloudPlayoutScheduleEvent

An event on a Cloud Playout schedule channel.

- `id` (string, optional) — The unique identifier FastPix assigns to the event. Use this identifier when you update or remove it.
- `channelId` (string, optional) — The unique identifier of the channel the event is scheduled on.
- `type` (enum, optional) — What the event plays. A `playlist` you scheduled is returned as one `vod` event per item in it.
  - Allowed values: `vod`, `live`
- `referenceId` (string, optional, nullable) — The unique identifier of the media the event plays. Not returned for a `live` event.
- `name` (string, optional) — The name of the event. For a `vod` event this is the media's title, and for a `live` event it is the name you gave the event.
- `startTime` (datetime, optional) — When the event starts, defined as a localDateTime (UTC Time).
- `endTime` (datetime, optional) — When the event ends, defined as a localDateTime (UTC Time).
- `duration` (string, optional) — How long the event runs, formatted as `HH:MM:SS`.
- `sourceResolution` (string, optional) — The resolution the event is played out at.
- `thumbnail` (string, optional, nullable) — A URL to the event's thumbnail image.
- `bumper` (CloudPlayoutScheduleEventBumper, optional) — The bumpers attached to the event. Each key is present only when a bumper of that kind is attached.
- `segments` (list of CloudPlayoutSegment, optional) — The segments marked on the event, in the order they occur.
- `createdAt` (datetime, optional) — Time the event was created, defined as a localDateTime (UTC Time).
- `updatedAt` (datetime, optional) — Time the event was last updated, defined as a localDateTime (UTC Time).

### CloudPlayoutScheduleEventBumper

The bumpers attached to the event. Each key is present only when a bumper of that kind is attached.

- `preroll` (CloudPlayoutScheduleEventRollResponse, optional)
- `postroll` (CloudPlayoutScheduleEventRollResponse, optional)

### CloudPlayoutSegment

A time window marked on an item, which can carry bumpers around it.

- `id` (string, optional) — The unique identifier FastPix assigns to the segment.
- `segmentMediaId` (string, optional) — The unique identifier of the media the segment is marked on.
- `startTime` (integer, optional) — The point in the media where the segment begins, in seconds from the start of the media.
- `duration` (integer, optional) — The length of the segment in seconds.
- `bumper` (CloudPlayoutSegmentBumper, optional) — The bumpers attached to this segment. Each key is present only when a bumper of that kind has been added.
- `thumbnail` (string, optional, nullable) — A URL to the segment's thumbnail image.
- `status` (string, optional, nullable) — The current state of the segment.

### CloudPlayoutScheduleEventRollResponse

- `id` (string, optional) — The unique identifier of the bumper.
- `duration` (integer, optional) — The duration of the bumper in seconds.

### CloudPlayoutSegmentBumper

The bumpers attached to this segment. Each key is present only when a bumper of that kind has been added.

- `preroll` (CloudPlayoutSegmentBumper, optional) — The bumpers attached to this segment. Each key is present only when a bumper of that kind has been added.
- `postroll` (CloudPlayoutSegmentBumper, optional) — The bumpers attached to this segment. Each key is present only when a bumper of that kind has been added.

## Examples

**Response**

```json
{
  "success": true,
  "data": [
    {
      "id": "b1d6f0a7-4e28-4b93-90c5-7f2a8c1d3e64",
      "channelId": "cc99cae6-56b4-46ab-9f4a-8b2462d8137c",
      "type": "vod",
      "referenceId": "8c2c4ef1-1c2a-4a49-9c5b-8f9c0a7c3d21",
      "name": "Morning headlines",
      "startTime": "2026-09-02T18:00:00Z",
      "endTime": "2026-09-02T18:10:30Z",
      "duration": "00:10:30",
      "sourceResolution": "1080p",
      "thumbnail": "https://images.fastpix.com/8c2c4ef1-1c2a-4a49-9c5b-8f9c0a7c3d21/thumbnail.png",
      "segments": [],
      "createdAt": "2026-08-20T09:02:11.114530Z",
      "updatedAt": "2026-08-20T09:02:11.114530Z"
    },
    {
      "id": "3e5c7a90-8b2d-4f61-9c07-6d4a1b8e2f53",
      "channelId": "cc99cae6-56b4-46ab-9f4a-8b2462d8137c",
      "type": "live",
      "name": "Evening press conference",
      "startTime": "2026-09-02T19:00:00Z",
      "endTime": "2026-09-02T20:00:00Z",
      "duration": "01:00:00",
      "sourceResolution": "1080p",
      "segments": [],
      "createdAt": "2026-08-20T09:05:44.210338Z",
      "updatedAt": "2026-08-20T09:05:44.210338Z"
    }
  ]
}
```

**SDK Code**

```python
import requests

url = "https://api.fastpix.com/v1/cloud-playout/channels/cc99cae6-56b4-46ab-9f4a-8b2462d8137c/schedule-event"

response = requests.get(url, auth=("<username>", "<password>"))

print(response.json())
```

```javascript
const url = 'https://api.fastpix.com/v1/cloud-playout/channels/cc99cae6-56b4-46ab-9f4a-8b2462d8137c/schedule-event';
const credentials = btoa("<username>:<password>");

const options = {method: 'GET', headers: {Authorization: `Basic ${credentials}`}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.fastpix.com/v1/cloud-playout/channels/cc99cae6-56b4-46ab-9f4a-8b2462d8137c/schedule-event"

	req, _ := http.NewRequest("GET", url, nil)

	req.SetBasicAuth("<username>", "<password>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.fastpix.com/v1/cloud-playout/channels/cc99cae6-56b4-46ab-9f4a-8b2462d8137c/schedule-event")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request.basic_auth("<username>", "<password>")

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.fastpix.com/v1/cloud-playout/channels/cc99cae6-56b4-46ab-9f4a-8b2462d8137c/schedule-event")
  .basicAuth("<username>", "<password>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.fastpix.com/v1/cloud-playout/channels/cc99cae6-56b4-46ab-9f4a-8b2462d8137c/schedule-event', [
  'headers' => [
  ],
    'auth' => ['<username>', '<password>'],
]);

echo $response->getBody();
```

```csharp
using RestSharp;
using RestSharp.Authenticators;

var client = new RestClient("https://api.fastpix.com/v1/cloud-playout/channels/cc99cae6-56b4-46ab-9f4a-8b2462d8137c/schedule-event");
client.Authenticator = new HttpBasicAuthenticator("<username>", "<password>");
var request = new RestRequest(Method.GET);

IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let credentials = Data("<username>:<password>".utf8).base64EncodedString()

let headers = ["Authorization": "Basic \(credentials)"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.fastpix.com/v1/cloud-playout/channels/cc99cae6-56b4-46ab-9f4a-8b2462d8137c/schedule-event")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```