Sign in

v1

latestOpenAPI 3.0.32026-07-13401683.8 KB
Episodes

Gets episodes matching the given criteria.

get/api/v2/episodes

Query parameters

idinteger

Matches on the ID of the episode.

beginAirDateAfterstring date-time

Matches on the begin air date of the episode (inclusive) in ISO 8601 format.

endAirDateBeforestring date-time

Matches on the end air date of the episode (inclusive) in ISO 8601 format.

programIdinteger required

Matches on the ID of the program that owns the episode.

pageStartinteger

The start page of the results to return. The first item is indexed at 0.

pageSizeinteger

The number of items to return. Must be between 0 and 500, inclusive.

orderById'asc' | 'desc'

The sort order of the list of episodes, based on episode ID. If unspecified, the episodes are returned in random order. If using paging to iterate through the results, sort order should be specified.

Response

The matching episode.

idinteger

The unique ID of the episode. Generated at creation.

programIdinteger required

The ID of the program that owns this episode.

customerIdinteger

The ID of the customer that owns this programs.

titlestring required

The title of the program.

createdDatestring date-time

The date the segment was created in ISO 8601 format. Generated at creation.

lastModifiedDatestring date-time

The date the segment was last modified/updated in ISO 8601 format. Automatically updated on any write operation.

beginAirDatestring date-time required

The date the air window opens for the episode in ISO 8601 format.

endAirDatestring date-time required

The date the air window closes for the episode in ISO 8601 format.

beginTransmissionDatestring date-time

The date the live stream begins for the episode in ISO 8601 format. Only set for live and LWSF episodes.

endTransmissionDatestring date-time

The date the live stream ends for the episode in ISO 8601 format. Only set for live and LWSF episodes.