Support Articles
Server API: Playlists
Beta
Playlists allow you to create a linear list of movies, episodes, or videos. On this page, we’ll dive into the different playlist endpoints you can use to read playlist information programmatically from the Channels library.
The playlists model
The playlist model contains all the information about the Playlists in your library, such as their name, art, last watched date, etc. Additionally, you can fetch all of the content of a playlist using the nested endpoint.
Properties
The unique identifier for the playlist.
The name of the playlist.
An array of strings for the labels of the playlist. Labels are self assigned strings used for organizing items in the library.
The number of items contained in the playlist.
The date of the last time content inside the playlist was watched.
The date when the playlist was first added to the library.
The date when the playlist was last updated.
GET /api/v1/playlists
List all playlists
Returns a list of all playlists in the library alphabetically.
GET /api/v1/playlists/:id
Retrieve a playlist
This endpoint allows you to retrieve a playlist by using its unique identifier.
Required Attributes
The unique identifier of the Playlist.
GET /api/v1/playlists/:id/content
Retrieve a playlist's contents
This endpoint allows you to retrieve all the content contained by a playlist.
Required Attributes
The unique identifier of the Playlist.
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.