Skip to navigation
CLOUD PLAYOUT APILoop programs

Get program by ID

This endpoint retrieves a single program on a Cloud Playout loop channel, using the channel’s and the program’s unique identifiers.

How it works

  1. Make a GET request to this endpoint, replacing {channelId} and {programId} with the UUIDs of the channel and the program.

  2. The response contains the program, including its position in the loop, the number of items it holds, and their combined duration.

The program has to belong to the channel named in the path. A program that belongs to a different channel or workspace is not returned.

Example

Before adding another episode to a block, an operator retrieves the program to check how long it already runs.

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 loop channel the program belongs to.
programIdstringRequiredformat: "uuid"
The unique identifier of the program, returned by FastPix when the program was created.

Response

Program details fetched successfully
successbooleanOptional
Shows the request status. Returns true for success and false for failure.
dataobjectOptional
A program on a Cloud Playout loop channel.