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
The unique identifier for the TV show.
The name of the TV show.
The summary of the TV show.
The URL of the poster image for the TV show.
The year the TV show originally aired.
The date the TV show originally aired.
An array of strings for the genres of the TV show.
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.
An array of strings for the labels of the TV show. Labels are self assigned strings used for organizing items in the library.
An array of strings for the cast of the TV show.
The number of episodes contained in the TV show.
The number of unwatched episodes for the TV show.
Whether or not the TV show has been favorited.
The date of the last time an episode of the TV show was watched.
The date of the last time an episode was recorded for the TV show.
The date when the TV show was first added to the library.
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
Only return shows with their complete watch status corresponding to the passed in value.
Only return shows with their favorited status corresponding to the passed in value.
Sorting Attributes
Sort the response based on the passed in value.
Set the order of the response.
GET /api/v1/shows/:id
Retrieve a show
This endpoint allows you to retrieve a show by using its unique identifier.
Required Attributes
The unique identifier of the Show.
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
The unique identifier of the Show.
Optional Attributes
Only return episodes with watch status corresponding to the passed in value.
Only return episodes with favorited status corresponding to the passed in value.
Only return episodes with verified status corresponding to the passed in value.
Only return episodes sourced from the passed in value.
Sorting Attributes
Sort the response based on the passed in value.
Set the order of the response.