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

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

This endpoint retrieves the Cloud Playout channels in a workspace. The list is sorted by the time each channel was created and is returned in pages.

#### How it works

1. Make a GET request to this endpoint and set the `type` parameter to `loop`, `schedule`, or `all` to list both kinds of channel together.

2. Optionally use the `offset` and `limit` query parameters to page through the list, and `orderBy` to sort by creation time.

3. The response includes the matching channels and pagination metadata.

#### Example

An operations dashboard lists all channels in the workspace to show which are on air, which are still in draft, and when each one is scheduled to end.


Reference: https://fastpix.com/docs/cloud-playout-channels/list-cloud-playout-channels

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

### Query parameters

- `type` (enum, required) — The kind of channel to list. Use `all` to list both `loop` and `schedule` channels.
  - Allowed values: `loop`, `schedule`, `all`
- `limit` (integer, optional, default: 10) — Limit specifies the maximum number of items to display per page.
- `offset` (integer, optional, default: 1) — Offset determines the starting point for data retrieval within a paginated list.
- `orderBy` (enum, optional, default: desc) — The sort order of the channels, based on the time each channel was created.
  - Allowed values: `asc`, `desc`

## Response

### 200

Channels fetched successfully

- `success` (boolean, optional) — Shows the request status. Returns true for success and false for failure.
- `data` (list of CloudPlayoutChannel, optional) — The channels in the workspace that match the request.
- `pagination` (Pagination, optional) — Pagination organizes content into pages for better readability and navigation.

## Types

### CloudPlayoutChannel

A Cloud Playout channel.

- `id` (string, optional) — The unique identifier FastPix assigns to the channel.
- `name` (string, optional) — The name given to the channel.
- `logo` (string, optional) — The URL of the channel's logo image. Present only when one was given.
- `description` (string, optional) — The description given to the channel. Present only when one was given.
- `ingestionPoint` (string, optional) — The RTMPS URL to send a live source to when the channel plays a live slot. Present for `schedule` channels and for `loop` channels with live support.
- `destination` (string, optional) — Where the channel is delivered. Present only when it was given.
- `startTime` (datetime, optional) — The time the channel starts, defined as a localDateTime (UTC Time).
- `endTime` (datetime, optional) — The time the channel ends, defined as a localDateTime (UTC Time).
- `liveSupport` (boolean, optional) — Whether the channel can switch to a live source. Present for `loop` channels.
- `status` (enum, optional) — The current status of the channel. A newly created channel is in `draft`. Activating it moves it to `scheduled`; at its start time it passes through `starting` to `running`, and it moves to `completed` when it reaches its end time. Deactivating a channel moves it through `stopping` to `idle`, from which it can be activated again. `deleting` is the transient state while a delete request is processed, and `error` is reported when playout could not be started or was interrupted.
  - Allowed values: `draft`, `scheduled`, `starting`, `running`, `stopping`, `idle`, `completed`, `deleting`, `error`
- `workspaceId` (string, optional) — The unique identifier of the workspace the channel was created in.
- `createdAt` (datetime, optional) — Time the channel was created, defined as a localDateTime (UTC Time).
- `updatedAt` (datetime, optional) — Time the channel was last updated, defined as a localDateTime (UTC Time).
- `slateId` (string, optional) — The slate shown when no other content is available, as the ID of a `slate` filler or `default` for the FastPix slate.
- `type` (enum, optional) — How the channel is programmed.
  - Allowed values: `loop`, `schedule`
- `captions` (boolean, optional) — Whether captions are generated for the channel's output. Present for `loop` channels.
- `genres` (list of string, optional) — The genres that describe the channel's content. Present for `schedule` channels when genres were given.
- `encodingTier` (string, optional) — The encoding tier the channel is played out with. It is assigned by FastPix.
- `playbackUrl` (string, optional) — The HLS playback URL for the channel's output. It is available as soon as the channel is created and serves content once the channel is `running`.
- `inputPlaybackUrl` (string, optional) — The HLS playback URL of the channel's live input, for previewing a live source before it goes to air. Present when the channel has a live input.
- `destinationUrl` (string, optional) — The RTMPS URL FastPix delivers the channel's output to.
- `destinationLiveId` (string, optional) — The identifier of the live stream that carries the channel's output. Use it with the live stream APIs, for example to add a private playback ID or restrict playback.
- `inputLiveId` (string, optional) — The identifier of the live stream that receives the channel's live input. Present when the channel has a live input.

### Pagination

Pagination organizes content into pages for better readability and navigation.

- `totalRecords` (integer, optional) — The total number of records matching the request, across all pages.
- `currentOffset` (integer, optional) — The page returned by this response. Pages are numbered from 1, so the first page has a `currentOffset` of 1.
- `offsetCount` (integer, optional) — The total number of pages: `totalRecords` divided by `limit`, rounded up.

## Examples

**Response**

```json
{
  "success": true,
  "data": [
    {
      "id": "cc99cae6-56b4-46ab-9f4a-8b2462d8137c",
      "name": "News 24x7",
      "ingestionPoint": "rtmps://live.fastpix.com:443/live/493e43e13ac83bb49672403f0fba52b8k17eed9dd1c9c18fe8177d5b547007ef4",
      "startTime": "2026-11-01T00:00:00Z",
      "endTime": "2026-11-08T00:00:00Z",
      "liveSupport": true,
      "status": "running",
      "workspaceId": "37d62550-e2a5-4827-b16a-3826e66d77ad",
      "createdAt": "2026-10-12T06:17:26.403017Z",
      "updatedAt": "2026-11-01T00:00:04.118220Z",
      "slateId": "default",
      "type": "loop",
      "captions": false,
      "encodingTier": "standard",
      "playbackUrl": "https://stream.fastpix.com/d6bf9101-7d5f-4247-b5a4-0ffc91896ba3.m3u8",
      "inputPlaybackUrl": "https://stream.fastpix.com/396ce915-0978-4d49-a662-06c7f975dd6b.m3u8",
      "destinationUrl": "rtmps://live.fastpix.com:443/live/9150bf73432f52483b4b819237eab3afk41b0002bba7a1f971fbada1cc746a04f",
      "destinationLiveId": "41b0002bba7a1f971fbada1cc746a04f",
      "inputLiveId": "17eed9dd1c9c18fe8177d5b547007ef4"
    },
    {
      "id": "f4e1db13-9a2c-4e18-8f3d-6b2c9d0a1e77",
      "name": "Weekend movies",
      "ingestionPoint": "rtmps://live.fastpix.com:443/live/d106fc2e0b72de27c37e15504ece74f1k78477058813be9429b2c44748a254be6",
      "startTime": "2026-11-07T18:00:00Z",
      "endTime": "2026-11-08T02:00:00Z",
      "status": "draft",
      "workspaceId": "37d62550-e2a5-4827-b16a-3826e66d77ad",
      "createdAt": "2026-10-11T09:02:11.114530Z",
      "updatedAt": "2026-10-11T09:02:11.114530Z",
      "slateId": "default",
      "type": "schedule",
      "genres": [
        "movies"
      ],
      "encodingTier": "standard",
      "playbackUrl": "https://stream.fastpix.com/348aec86-7196-4ca6-a398-b68a713cf8c4.m3u8",
      "inputPlaybackUrl": "https://stream.fastpix.com/e6f130fa-5992-4429-8209-27e42200de14.m3u8",
      "destinationUrl": "rtmps://live.fastpix.com:443/live/92020929721d6575d756ecb5176a4198k82aecaa8e4aff1cd3546a73d0a8556d1",
      "destinationLiveId": "82aecaa8e4aff1cd3546a73d0a8556d1",
      "inputLiveId": "78477058813be9429b2c44748a254be6"
    }
  ],
  "pagination": {
    "totalRecords": 2,
    "currentOffset": 1,
    "offsetCount": 1
  }
}
```

**SDK Code**

```python
import requests

url = "https://api.fastpix.com/v1/cloud-playout/channels"

querystring = {"type":"loop"}

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

print(response.json())
```

```javascript
const url = 'https://api.fastpix.com/v1/cloud-playout/channels?type=loop';
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?type=loop"

	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?type=loop")

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?type=loop")
  .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?type=loop', [
  '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?type=loop");
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?type=loop")! 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()
```