Support Articles

Server API: Shows

Beta

Shows are a core part of Channels, these are the titled items that group episodes. Shows are full of their own metadata. On this page, we’ll dive into the different show endpoints you can use to read show information programmatically from the Channels library.

The show model

The show model contains all the information about your TV shows in your library, such as their name, poster art, last watched date, etc. Additionally, you can fetch all of the episodes of a show using the nested endpoint.

Properties

id string

The unique identifier for the TV show.

name string

The name of the TV show.

summary string

The summary of the TV show.

image_url string

The URL of the poster image for the TV show.

release_year string

The year the TV show originally aired.

release_date string

The date the TV show originally aired.

genres array

An array of strings for the genres of the TV show.

categories array

An array of strings for the categories of the TV show. Categories describe the type of content the TV show is such as Series, Miniseries, etc.

labels array

An array of strings for the labels of the TV show. Labels are self assigned strings used for organizing items in the library.

cast array

An array of strings for the cast of the TV show.

episode_count integer

The number of episodes contained in the TV show.

number_unwatched integer

The number of unwatched episodes for the TV show.

favorited boolean

Whether or not the TV show has been favorited.

last_watched_at timestamp

The date of the last time an episode of the TV show was watched.

last_recorded_at timestamp

The date of the last time an episode was recorded for the TV show.

created_at timestamp

The date when the TV show was first added to the library.

updated_at timestamp

The date when the TV show was last updated.

GET /api/v1/shows

List all shows

Returns a list of all TV shows in the library.

Optional Attributes

watched boolean

Only return shows with their complete watch status corresponding to the passed in value.

favorited boolean

Only return shows with their favorited status corresponding to the passed in value.

Sorting Attributes

sort string

Sort the response based on the passed in value.

Options

alpha default
Sort by the title of the show.

date_added
Sort by the date the show was added to the library.

date_released
Sort by the date the show originally aired.

date_watched
Sort by the date the show was last watched.

date_updated
Sort by date the show was last updated.

order string

Set the order of the response.

Options

asc default
Ascending order.

desc
Descending order.

Request

GET /api/v1/shows

curl http://192.168.1.3:8089/api/v1/shows

Response

[{"id":"183983","name":"Law & Order","summary":"Filmed on location in New York, the drama showcases the sometimes-complex process of determining guilt or innocence, while lives hang in the balance. Often inspired by the latest headlines, the plots highlight legal, ethical or personal dilemmas to which people can relate.","image_url":"https://tmsimg.fancybits.co/assets/p7893681_b_h9_aa.jpg?w=720&h=540","release_year":1990,"release_date":"1990-09-13","genres":["Crime drama"],"categories":["Show","Series"],"labels":["dad-shows","90s"],"cast":["Sam Waterston","S. Epatha Merkerson","Anthony Anderson","Alana De La Garza","Jeremy Sisto","Linus Roache","Jerry Orbach","Benjamin Bratt","Steven Hill","Michael Moriarty","Shirley Knight","Angie Harmon","Jesse L. Martin","Dianne Wiest","Carey Lowell","Fred Dalton Thompson","Elisabeth Rohm"],"episode_count":327,"number_unwatched":91,"favorited":false,"last_watched_at":1676964697827,"last_recorded_at":1669733074598,"created_at":1594918770000,"updated_at":1676964697827},{"id":"17223","name":"Friends",...}]

GET /api/v1/shows/:id

Retrieve a show

This endpoint allows you to retrieve a show by using its unique identifier.

Required Attributes

id string

The unique identifier of the Show.

Request

GET /api/v1/shows/183983

curl http://192.168.1.3:8089/api/v1/shows/183983

Response

{"id":"183983","name":"Law & Order","summary":"Filmed on location in New York, the drama showcases the sometimes-complex process of determining guilt or innocence, while lives hang in the balance. Often inspired by the latest headlines, the plots highlight legal, ethical or personal dilemmas to which people can relate.","image_url":"https://tmsimg.fancybits.co/assets/p7893681_b_h9_aa.jpg?w=720&h=540","release_year":1990,"release_date":"1990-09-13","genres":["Crime drama"],"categories":["Show","Series"],"labels":["dad-shows","90s"],"cast":["Sam Waterston","S. Epatha Merkerson","Anthony Anderson","Alana De La Garza","Jeremy Sisto","Linus Roache","Jerry Orbach","Benjamin Bratt","Steven Hill","Michael Moriarty","Shirley Knight","Angie Harmon","Jesse L. Martin","Dianne Wiest","Carey Lowell","Fred Dalton Thompson","Elisabeth Rohm"],"episode_count":327,"number_unwatched":91,"favorited":false,"last_watched_at":1676964697827,"last_recorded_at":1669733074598,"created_at":1594918770000,"updated_at":1676964697827}

GET /api/v1/shows/:id/episodes

Retrieve a show's episodes

This endpoint allows you to retrieve all the episodes contained by a show.

Required Attributes

id string

The unique identifier of the Show.

Optional Attributes

watched boolean

Only return episodes with watch status corresponding to the passed in value.

favorited boolean

Only return episodes with favorited status corresponding to the passed in value.

verified boolean

Only return episodes with verified status corresponding to the passed in value.

source string

Only return episodes sourced from the passed in value.

Options

recordings
Episodes recorded directly via Channels.

imports
Episodes added to the library via local content sources.

playon-cloud
Episodes added to the library from PlayOn Cloud.

stream-links
Episodes added to the library via a Stream Link.

stream-files
Episodes added to the library via a Stream File.

Sorting Attributes

sort string

Sort the response based on the passed in value.

Options

date_added default
Sort by the date the episode was added to the library.

date_released
Sort by the date the episode originally aired.

date_watched
Sort by the date the episode was last watched.

duration
Sort by length of the episode.

order string

Set the order of the response.

Options

asc
Ascending order.

desc default
Descending order.

Request

GET /api/v1/shows/183983/episodes

curl http://192.168.1.3:8089/api/v1/shows/183983/episodes

Response

[{"id":"31260","show_id":"183983","program_id":"EP000176170013","path":"/shares/DVR/TV/Law & Order/Law & Order S01E18 1991年03月12日 The Secret Sharers 2022年11月25日-2359.mpg","channel":"512","season_number":1,"episode_number":18,"title":"Law & Order","episode_title":"The Secret Sharers","summary":"The probe of a felon's murder is hobbled by a cover-up to protect the killer.","full_summary":"A community rallies to protect a teen who shot a neighborhood drug dealer in front of a church gathering.","content_rating":"TV-PG","image_url":"https://tmsimg.fancybits.co/assets/p183983_b_h9_bl.jpg?w=720&h=540","thumbnail_url":"/dvr/files/31260/preview.jpg","duration":3671.601367,"playback_time":0,"original_air_date":"1991-03-12","genres":["Crime drama"],"tags":["CC","HD 1080i","HDTV","Stereo"],"categories":["Episode","Series"],"cast":["George Dzundza","Chris Noth","Dann Florek"],"commercials":[55.09,100.60000000000001,259.03000000000003,471.14,1053.52,1280.48,1724.42,1956.52,2527.56,2759.52,3332.46,3528.76],"watched":false,"favorited":false,"delayed":false,"cancelled":false,"corrupted":false,"completed":true,"processed":true,"locked":false,"verified":false,"created_at":1669438770000,"updated_at":1669733074609},{"id":"31254","show_id":"183983",...}]