Get all overlays on a channel | FastPix Developer Documentation

{
  "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
    }
  ]
}

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

How it works

Make a GET request to this endpoint with the channelId.
The response returns each placement with the overlay it uses, when it comes on air, and how it is sized and positioned.
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.

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 overlays are retrieved.

Query parameters

startTimestringOptional

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.

endTimestringOptional

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

Channel overlays retrieved successfully

successbooleanOptional

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

datalist of objectsOptional

The overlays placed on the channel.