JEjellyfin
LiveTv

Gets available live tv epgs.

get/LiveTv/Programs

Request

Query parameters

channelIdsstring[] nullable

The channels to return guide information for.

userIdstring uuid nullable

Optional. Filter by user id.

minStartDatestring date-time nullable

Optional. The minimum premiere start date.

hasAiredboolean nullable

Optional. Filter by programs that have completed airing, or not.

isAiringboolean nullable

Optional. Filter by programs that are currently airing, or not.

maxStartDatestring date-time nullable

Optional. The maximum premiere start date.

minEndDatestring date-time nullable

Optional. The minimum premiere end date.

maxEndDatestring date-time nullable

Optional. The maximum premiere end date.

isMovieboolean nullable

Optional. Filter for movies.

isSeriesboolean nullable

Optional. Filter for series.

isNewsboolean nullable

Optional. Filter for news.

isKidsboolean nullable

Optional. Filter for kids.

isSportsboolean nullable

Optional. Filter for sports.

startIndexinteger nullable

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.

sortBystring nullable

Optional. Specify one or more sort orders, comma delimited. Options: Name, StartDate.

sortOrderstring nullable

Sort Order - Ascending,Descending.

genresstring[] nullable

The genres to return guide information for.

genreIdsstring[] nullable

The genre ids to return guide information for.

enableImagesboolean nullable

Optional. Include image information in output.

imageTypeLimitinteger nullable

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

enableImageTypesImageType[] nullable

Optional. The image types to include in the output.

enableUserDataboolean nullable

Optional. Include user data.

seriesTimerIdstring nullable

Optional. Filter by series timer id.

librarySeriesIdstring uuid nullable

Optional. Filter by library series id.

fieldsItemFields[] nullable

Optional. Specify additional fields of information to return in the output.

enableTotalRecordCountboolean

Retrieve total record count.

Response

Live tv epgs returned.

TotalRecordCountinteger

The total number of records available.

StartIndexinteger

The index of the first record in Items.

Changes

No recorded changes to this operation across all 1 revision of this API.