Channels

Get channel items.

get/Channels/{channelId}/Items

Request

Path parameters

channelIdstring uuid required

Channel Id.

Query parameters

folderIdstring uuid nullable

Optional. Folder Id.

userIdstring uuid nullable

Optional. User Id.

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.

sortOrderstring nullable

Optional. Sort Order - Ascending,Descending.

filtersItemFilter[] nullable

Optional. Specify additional filters to apply.

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.

fieldsItemFields[] nullable

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

Response

Channel items 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.