> 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 all overlays on a channel

GET https://api.fastpix.com/v1/cloud-playout/channels/{channelId}/overlays

This endpoint retrieves every overlay placed on a Cloud Playout channel, so you can see what the channel renders and when.

#### How it works

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

2. The response returns each placement with the overlay it uses, when it comes on air, and how it is sized and positioned.

3. Use the `id` of a placement to update or remove it.

Every placement on the channel is returned. Narrow the list to a period with `startTime` and `endTime`, or leave both out to get them all.

#### Example

A playout dashboard lists the overlays due in the next hour so an operator can confirm the right sponsor bug is scheduled.


Reference: https://fastpix.com/docs/cloud-playout-api/channel-overlays/get-all-cloud-playout-channel-overlays

## 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

- `channelId` (string, required) — The unique identifier of the channel whose overlays are retrieved.

### Query parameters

- `startTime` (string, optional) — Only return overlays that are on air at or after this time, in `yyyy-MM-dd'T'HH:mm:ss` format and interpreted as UTC. Applies to schedule channels only.
- `endTime` (string, optional) — Only return overlays that are on air at or before this time, in `yyyy-MM-dd'T'HH:mm:ss` format and interpreted as UTC. Applies to schedule channels only.

## Response

### 200

Channel overlays retrieved successfully

- `success` (boolean, optional) — Shows the request status. Returns true for success and false for failure.
- `data` (list of CloudPlayoutChannelOverlay, optional) — The overlays placed on the channel.

## Types

### CloudPlayoutChannelOverlay

An overlay placed on a Cloud Playout channel.

- `id` (string, optional) — The unique identifier FastPix assigns to the placement. Use this identifier when you update or remove the overlay from the channel.
- `overlayId` (string, optional) — The unique identifier of the overlay that was placed.
- `channelId` (string, optional) — The unique identifier of the channel the overlay is placed on.
- `name` (string, optional) — The name given to the overlay.
- `type` (enum, optional) — The kind of overlay. A `static` overlay shows a fixed image or video, and a `dynamic` overlay renders content that changes while it is on air.
  - Allowed values: `static`, `dynamic`
- `overlayLayoutType` (string, optional) — The layout the overlay was created with, such as a logo, an aston, or an L-band.
- `overlayImageURL` (string, optional) — A URL to the overlay's source file.
- `startTime` (datetime, optional) — When the overlay comes on air, defined as a localDateTime (UTC Time).
- `endTime` (datetime, optional) — When the overlay goes off air, defined as a localDateTime (UTC Time).
- `duration` (string, optional) — How long the overlay stays on air, formatted as `HH:MM:SS`.
- `untilChannelEnd` (boolean, optional) — Whether the overlay stays on air until the channel's end time.
- `customResolution` (boolean, optional) — Whether the overlay was given its own width and height.
- `width` (integer, optional) — The width of the overlay in pixels.
- `height` (integer, optional) — The height of the overlay in pixels.
- `position` (boolean, optional) — Whether the overlay was given its own position.
- `positionX` (integer, optional) — The distance of the overlay's left edge from the left edge of the frame, in pixels.
- `positionY` (integer, optional) — The distance of the overlay's top edge from the top edge of the frame, in pixels.
- `opacity` (integer, optional) — How opaque the overlay is, from 1 to 100.

## Examples

**Response**

```json
{
  "success": true,
  "data": [
    {
      "id": "5e8b2c31-7a49-4d62-b0f8-9c1e4a7d2b53",
      "overlayId": "2f6c1d84-9b3a-4d0e-8f21-5c7e3a9b4d16",
      "channelId": "cc99cae6-56b4-46ab-9f4a-8b2462d8137c",
      "name": "Channel logo",
      "type": "static",
      "overlayLayoutType": "logo",
      "overlayImageURL": "https://images.fastpix.com/2f6c1d84-9b3a-4d0e-8f21-5c7e3a9b4d16/overlay.png",
      "startTime": "2026-09-02T18:00:00Z",
      "endTime": "2026-09-02T18:10:00Z",
      "duration": "00:10:00",
      "untilChannelEnd": false,
      "customResolution": false,
      "width": 100,
      "height": 100,
      "position": true,
      "positionX": 40,
      "positionY": 40,
      "opacity": 100
    }
  ]
}
```

**SDK Code**

```python
import requests

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

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/overlays';
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/overlays"

	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/overlays")

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/overlays")
  .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/overlays', [
  '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/overlays");
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/overlays")! 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()
```