v1

latestOpenAPI 3.0.12026-07-134082641.7 MB
TvShows

Gets episodes for a tv season.

get/Shows/{seriesId}/Episodes

Path parameters

seriesIdstring uuid required

The series id.

The series id.

Query parameters

userIdstring uuid nullable

The user id.

The user id.

fieldsItemFields[] nullable

Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls.

Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls.

seasoninteger nullable

Optional filter by season number.

Optional filter by season number.

seasonIdstring uuid nullable

Optional. Filter by season id.

Optional. Filter by season id.

isMissingboolean nullable

Optional. Filter by items that are missing episodes or not.

Optional. Filter by items that are missing episodes or not.

adjacentTostring nullable

Optional. Return items that are siblings of a supplied item.

Optional. Return items that are siblings of a supplied item.

startItemIdstring uuid nullable

Optional. Skip through the list until a given item is found.

Optional. Skip through the list until a given item is found.

startIndexinteger nullable

Optional. The record index to start at. All items with a lower index will be dropped from the results.

Optional. The record index to start at. All items with a lower index will be dropped from the results.

limitinteger nullable

Optional. The maximum number of records to return.

Optional. The maximum number of records to return.

enableImagesboolean nullable

Optional, include image information in output.

Optional, include image information in output.

imageTypeLimitinteger nullable

Optional, the max number of images to return, per image type.

Optional, the max number of images to return, per image type.

enableImageTypesImageType[] nullable

Optional. The image types to include in the output.

Optional. The image types to include in the output.

enableUserDataboolean nullable

Optional. Include user data.

Optional. Include user data.

sortBystring nullable

Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.

Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.

Response

Success

TotalRecordCountinteger

The total number of records available.

StartIndexinteger

The index of the first record in Items.