Skip to navigation
Cloud Playout Channels

Get all 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.

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

Query parameters

typeenumRequired

The kind of channel to list. Use all to list both loop and schedule channels.

Allowed values:
limitintegerOptional1-50Defaults to 10
Limit specifies the maximum number of items to display per page.
offsetintegerOptional>=1Defaults to 1
Offset determines the starting point for data retrieval within a paginated list.
orderByenumOptionalDefaults to desc
The sort order of the channels, based on the time each channel was created.
Allowed values:

Response

Channels fetched successfully
successbooleanOptional
Shows the request status. Returns true for success and false for failure.
datalist of objectsOptional
The channels in the workspace that match the request.
paginationobjectOptional
Pagination organizes content into pages for better readability and navigation.