Interface ItemsApiGetItemsRequest

Request parameters for getItems operation in ItemsApi.

Export

ItemsApiGetItemsRequest

interface ItemsApiGetItemsRequest {
    adjacentTo?: string;
    albumArtistIds?: string[];
    albumIds?: string[];
    albums?: string[];
    artistIds?: string[];
    artists?: string[];
    collapseBoxSetItems?: boolean;
    contributingArtistIds?: string[];
    enableImages?: boolean;
    enableImageTypes?: ImageType[];
    enableTotalRecordCount?: boolean;
    enableUserData?: boolean;
    excludeArtistIds?: string[];
    excludeItemIds?: string[];
    excludeItemTypes?: BaseItemKind[];
    excludeLocationTypes?: LocationType[];
    fields?: ItemFields[];
    filters?: ItemFilter[];
    genreIds?: string[];
    genres?: string[];
    hasImdbId?: boolean;
    hasOfficialRating?: boolean;
    hasOverview?: boolean;
    hasParentalRating?: boolean;
    hasSpecialFeature?: boolean;
    hasSubtitles?: boolean;
    hasThemeSong?: boolean;
    hasThemeVideo?: boolean;
    hasTmdbId?: boolean;
    hasTrailer?: boolean;
    hasTvdbId?: boolean;
    ids?: string[];
    imageTypeLimit?: number;
    imageTypes?: ImageType[];
    includeItemTypes?: BaseItemKind[];
    indexNumber?: number;
    is3D?: boolean;
    is4K?: boolean;
    isFavorite?: boolean;
    isHd?: boolean;
    isKids?: boolean;
    isLocked?: boolean;
    isMissing?: boolean;
    isMovie?: boolean;
    isNews?: boolean;
    isPlaceHolder?: boolean;
    isPlayed?: boolean;
    isSeries?: boolean;
    isSports?: boolean;
    isUnaired?: boolean;
    limit?: number;
    locationTypes?: LocationType[];
    maxHeight?: number;
    maxOfficialRating?: string;
    maxPremiereDate?: string;
    maxWidth?: number;
    mediaTypes?: MediaType[];
    minCommunityRating?: number;
    minCriticRating?: number;
    minDateLastSaved?: string;
    minDateLastSavedForUser?: string;
    minHeight?: number;
    minOfficialRating?: string;
    minPremiereDate?: string;
    minWidth?: number;
    nameLessThan?: string;
    nameStartsWith?: string;
    nameStartsWithOrGreater?: string;
    officialRatings?: string[];
    parentId?: string;
    parentIndexNumber?: number;
    person?: string;
    personIds?: string[];
    personTypes?: string[];
    recursive?: boolean;
    searchTerm?: string;
    seriesStatus?: SeriesStatus[];
    sortBy?: ItemSortBy[];
    sortOrder?: SortOrder[];
    startIndex?: number;
    studioIds?: string[];
    studios?: string[];
    tags?: string[];
    userId?: string;
    videoTypes?: VideoType[];
    years?: number[];
}

Index

Properties

adjacentTo? albumArtistIds? albumIds? albums? artistIds? artists? collapseBoxSetItems? contributingArtistIds? enableImages? enableImageTypes? enableTotalRecordCount? enableUserData? excludeArtistIds? excludeItemIds? excludeItemTypes? excludeLocationTypes? fields? filters? genreIds? genres? hasImdbId? hasOfficialRating? hasOverview? hasParentalRating? hasSpecialFeature? hasSubtitles? hasThemeSong? hasThemeVideo? hasTmdbId? hasTrailer? hasTvdbId? ids? imageTypeLimit? imageTypes? includeItemTypes? indexNumber? is3D? is4K? isFavorite? isHd? isKids? isLocked? isMissing? isMovie? isNews? isPlaceHolder? isPlayed? isSeries? isSports? isUnaired? limit? locationTypes? maxHeight? maxOfficialRating? maxPremiereDate? maxWidth? mediaTypes? minCommunityRating? minCriticRating? minDateLastSaved? minDateLastSavedForUser? minHeight? minOfficialRating? minPremiereDate? minWidth? nameLessThan? nameStartsWith? nameStartsWithOrGreater? officialRatings? parentId? parentIndexNumber? person? personIds? personTypes? recursive? searchTerm? seriesStatus? sortBy? sortOrder? startIndex? studioIds? studios? tags? userId? videoTypes? years?

Properties

`Optional` `Readonly`adjacentTo

adjacentTo?: string

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

Memberof

ItemsApiGetItems

`Optional` `Readonly`albumArtistIds

albumArtistIds?: string[]

Optional. If specified, results will be filtered to include only those containing the specified album artist id.

Memberof

ItemsApiGetItems

`Optional` `Readonly`albumIds

albumIds?: string[]

Optional. If specified, results will be filtered based on album id. This allows multiple, pipe delimited.

Memberof

ItemsApiGetItems

`Optional` `Readonly`albums

albums?: string[]

Optional. If specified, results will be filtered based on album. This allows multiple, pipe delimited.

Memberof

ItemsApiGetItems

`Optional` `Readonly`artistIds

artistIds?: string[]

Optional. If specified, results will be filtered to include only those containing the specified artist id.

Memberof

ItemsApiGetItems

`Optional` `Readonly`artists

artists?: string[]

Optional. If specified, results will be filtered based on artists. This allows multiple, pipe delimited.

Memberof

ItemsApiGetItems

`Optional` `Readonly`collapseBoxSetItems

collapseBoxSetItems?: boolean

Whether or not to hide items behind their boxsets.

Memberof

ItemsApiGetItems

`Optional` `Readonly`contributingArtistIds

contributingArtistIds?: string[]

Optional. If specified, results will be filtered to include only those containing the specified contributing artist id.

Memberof

ItemsApiGetItems

`Optional` `Readonly`enableImages

enableImages?: boolean

Optional, include image information in output.

Memberof

ItemsApiGetItems

`Optional` `Readonly`enableImageTypes

enableImageTypes?: ImageType[]

Optional. The image types to include in the output.

Memberof

ItemsApiGetItems

`Optional` `Readonly`enableTotalRecordCount

enableTotalRecordCount?: boolean

Optional. Enable the total record count.

Memberof

ItemsApiGetItems

`Optional` `Readonly`enableUserData

enableUserData?: boolean

Optional, include user data.

Memberof

ItemsApiGetItems

`Optional` `Readonly`excludeArtistIds

excludeArtistIds?: string[]

Optional. If specified, results will be filtered based on artist id. This allows multiple, pipe delimited.

Memberof

ItemsApiGetItems

`Optional` `Readonly`excludeItemIds

excludeItemIds?: string[]

Optional. If specified, results will be filtered by excluding item ids. This allows multiple, comma delimited.

Memberof

ItemsApiGetItems

`Optional` `Readonly`excludeItemTypes

excludeItemTypes?: BaseItemKind[]

Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.

Memberof

ItemsApiGetItems

`Optional` `Readonly`excludeLocationTypes

excludeLocationTypes?: LocationType[]

Optional. If specified, results will be filtered based on the LocationType. This allows multiple, comma delimited.

Memberof

ItemsApiGetItems

`Optional` `Readonly`fields

fields?: ItemFields[]

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.

Memberof

ItemsApiGetItems

`Optional` `Readonly`filters

filters?: ItemFilter[]

Optional. Specify additional filters to apply. This allows multiple, comma delimited. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes.

Memberof

ItemsApiGetItems

`Optional` `Readonly`genreIds

genreIds?: string[]

Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.

Memberof

ItemsApiGetItems

`Optional` `Readonly`genres

genres?: string[]

Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.

Memberof

ItemsApiGetItems

`Optional` `Readonly`hasImdbId

hasImdbId?: boolean

Optional filter by items that have an IMDb id or not.

Memberof

ItemsApiGetItems

`Optional` `Readonly`hasOfficialRating

hasOfficialRating?: boolean

Optional filter by items that have official ratings.

Memberof

ItemsApiGetItems

`Optional` `Readonly`hasOverview

hasOverview?: boolean

Optional filter by items that have an overview or not.

Memberof

ItemsApiGetItems

`Optional` `Readonly`hasParentalRating

hasParentalRating?: boolean

Optional filter by items that have or do not have a parental rating.

Memberof

ItemsApiGetItems

`Optional` `Readonly`hasSpecialFeature

hasSpecialFeature?: boolean

Optional filter by items with special features.

Memberof

ItemsApiGetItems

`Optional` `Readonly`hasSubtitles

hasSubtitles?: boolean

Optional filter by items with subtitles.

Memberof

ItemsApiGetItems

`Optional` `Readonly`hasThemeSong

hasThemeSong?: boolean

Optional filter by items with theme songs.

Memberof

ItemsApiGetItems

`Optional` `Readonly`hasThemeVideo

hasThemeVideo?: boolean

Optional filter by items with theme videos.

Memberof

ItemsApiGetItems

`Optional` `Readonly`hasTmdbId

hasTmdbId?: boolean

Optional filter by items that have a TMDb id or not.

Memberof

ItemsApiGetItems

`Optional` `Readonly`hasTrailer

hasTrailer?: boolean

Optional filter by items with trailers.

Memberof

ItemsApiGetItems

`Optional` `Readonly`hasTvdbId

hasTvdbId?: boolean

Optional filter by items that have a TVDb id or not.

Memberof

ItemsApiGetItems

`Optional` `Readonly`ids

ids?: string[]

Optional. If specific items are needed, specify a list of item id's to retrieve. This allows multiple, comma delimited.

Memberof

ItemsApiGetItems

`Optional` `Readonly`imageTypeLimit

imageTypeLimit?: number

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

Memberof

ItemsApiGetItems

`Optional` `Readonly`imageTypes

imageTypes?: ImageType[]

Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited.

Memberof

ItemsApiGetItems

`Optional` `Readonly`includeItemTypes

includeItemTypes?: BaseItemKind[]

Optional. If specified, results will be filtered based on the item type. This allows multiple, comma delimited.

Memberof

ItemsApiGetItems

`Optional` `Readonly`indexNumber

indexNumber?: number

Optional filter by index number.

Memberof

ItemsApiGetItems

`Optional` `Readonly`is3D

is3D?: boolean

Optional filter by items that are 3D, or not.

Memberof

ItemsApiGetItems

`Optional` `Readonly`is4K

is4K?: boolean

Optional filter by items that are 4K or not.

Memberof

ItemsApiGetItems

`Optional` `Readonly`isFavorite

isFavorite?: boolean

Optional filter by items that are marked as favorite, or not.

Memberof

ItemsApiGetItems

`Optional` `Readonly`isHd

isHd?: boolean

Optional filter by items that are HD or not.

Memberof

ItemsApiGetItems

`Optional` `Readonly`isKids

isKids?: boolean

Optional filter for live tv kids.

Memberof

ItemsApiGetItems

`Optional` `Readonly`isLocked

isLocked?: boolean

Optional filter by items that are locked.

Memberof

ItemsApiGetItems

`Optional` `Readonly`isMissing

isMissing?: boolean

Optional filter by items that are missing episodes or not.

Memberof

ItemsApiGetItems

`Optional` `Readonly`isMovie

isMovie?: boolean

Optional filter for live tv movies.

Memberof

ItemsApiGetItems

`Optional` `Readonly`isNews

isNews?: boolean

Optional filter for live tv news.

Memberof

ItemsApiGetItems

`Optional` `Readonly`isPlaceHolder

isPlaceHolder?: boolean

Optional filter by items that are placeholders.

Memberof

ItemsApiGetItems

`Optional` `Readonly`isPlayed

isPlayed?: boolean

Optional filter by items that are played, or not.

Memberof

ItemsApiGetItems

`Optional` `Readonly`isSeries

isSeries?: boolean

Optional filter for live tv series.

Memberof

ItemsApiGetItems

`Optional` `Readonly`isSports

isSports?: boolean

Optional filter for live tv sports.

Memberof

ItemsApiGetItems

`Optional` `Readonly`isUnaired

isUnaired?: boolean

Optional filter by items that are unaired episodes or not.

Memberof

ItemsApiGetItems

`Optional` `Readonly`limit

limit?: number

Optional. The maximum number of records to return.

Memberof

ItemsApiGetItems

`Optional` `Readonly`locationTypes

locationTypes?: LocationType[]

Optional. If specified, results will be filtered based on LocationType. This allows multiple, comma delimited.

Memberof

ItemsApiGetItems

`Optional` `Readonly`maxHeight

maxHeight?: number

Optional. Filter by the maximum height of the item.

Memberof

ItemsApiGetItems

`Optional` `Readonly`maxOfficialRating

maxOfficialRating?: string

Optional filter by maximum official rating (PG, PG-13, TV-MA, etc).

Memberof

ItemsApiGetItems

`Optional` `Readonly`maxPremiereDate

maxPremiereDate?: string

Optional. The maximum premiere date. Format = ISO.

Memberof

ItemsApiGetItems

`Optional` `Readonly`maxWidth

maxWidth?: number

Optional. Filter by the maximum width of the item.

Memberof

ItemsApiGetItems

`Optional` `Readonly`mediaTypes

mediaTypes?: MediaType[]

Optional filter by MediaType. Allows multiple, comma delimited.

Memberof

ItemsApiGetItems

`Optional` `Readonly`minCommunityRating

minCommunityRating?: number

Optional filter by minimum community rating.

Memberof

ItemsApiGetItems

`Optional` `Readonly`minCriticRating

minCriticRating?: number

Optional filter by minimum critic rating.

Memberof

ItemsApiGetItems

`Optional` `Readonly`minDateLastSaved

minDateLastSaved?: string

Optional. The minimum last saved date. Format = ISO.

Memberof

ItemsApiGetItems

`Optional` `Readonly`minDateLastSavedForUser

minDateLastSavedForUser?: string

Optional. The minimum last saved date for the current user. Format = ISO.

Memberof

ItemsApiGetItems

`Optional` `Readonly`minHeight

minHeight?: number

Optional. Filter by the minimum height of the item.

Memberof

ItemsApiGetItems

`Optional` `Readonly`minOfficialRating

minOfficialRating?: string

Optional filter by minimum official rating (PG, PG-13, TV-MA, etc).

Memberof

ItemsApiGetItems

`Optional` `Readonly`minPremiereDate

minPremiereDate?: string

Optional. The minimum premiere date. Format = ISO.

Memberof

ItemsApiGetItems

`Optional` `Readonly`minWidth

minWidth?: number

Optional. Filter by the minimum width of the item.

Memberof

ItemsApiGetItems

`Optional` `Readonly`nameLessThan

nameLessThan?: string

Optional filter by items whose name is equally or lesser than a given input string.

Memberof

ItemsApiGetItems

`Optional` `Readonly`nameStartsWith

nameStartsWith?: string

Optional filter by items whose name is sorted equally than a given input string.

Memberof

ItemsApiGetItems

`Optional` `Readonly`nameStartsWithOrGreater

nameStartsWithOrGreater?: string

Optional filter by items whose name is sorted equally or greater than a given input string.

Memberof

ItemsApiGetItems

`Optional` `Readonly`officialRatings

officialRatings?: string[]

Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.

Memberof

ItemsApiGetItems

`Optional` `Readonly`parentId

parentId?: string

Specify this to localize the search to a specific item or folder. Omit to use the root.

Memberof

ItemsApiGetItems

`Optional` `Readonly`parentIndexNumber

parentIndexNumber?: number

Optional filter by parent index number.

Memberof

ItemsApiGetItems

`Optional` `Readonly`person

person?: string

Optional. If specified, results will be filtered to include only those containing the specified person.

Memberof

ItemsApiGetItems

`Optional` `Readonly`personIds

personIds?: string[]

Optional. If specified, results will be filtered to include only those containing the specified person id.

Memberof

ItemsApiGetItems

`Optional` `Readonly`personTypes

personTypes?: string[]

Optional. If specified, along with Person, results will be filtered to include only those containing the specified person and PersonType. Allows multiple, comma-delimited.

Memberof

ItemsApiGetItems

`Optional` `Readonly`recursive

recursive?: boolean

When searching within folders, this determines whether or not the search will be recursive. true/false.

Memberof

ItemsApiGetItems

`Optional` `Readonly`searchTerm

searchTerm?: string

Optional. Filter based on a search term.

Memberof

ItemsApiGetItems

`Optional` `Readonly`seriesStatus

seriesStatus?: SeriesStatus[]

Optional filter by Series Status. Allows multiple, comma delimited.

Memberof

ItemsApiGetItems

`Optional` `Readonly`sortBy

sortBy?: ItemSortBy[]

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.

Memberof

ItemsApiGetItems

`Optional` `Readonly`sortOrder

sortOrder?: SortOrder[]

Sort Order - Ascending, Descending.

Memberof

ItemsApiGetItems

`Optional` `Readonly`startIndex

startIndex?: number

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

Memberof

ItemsApiGetItems

`Optional` `Readonly`studioIds

studioIds?: string[]

Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimited.

Memberof

ItemsApiGetItems

`Optional` `Readonly`studios

studios?: string[]

Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited.

Memberof

ItemsApiGetItems

`Optional` `Readonly`tags

tags?: string[]

Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited.

Memberof

ItemsApiGetItems

`Optional` `Readonly`userId

userId?: string

The user id supplied as query parameter; this is required when not using an API key.

Memberof

ItemsApiGetItems

`Optional` `Readonly`videoTypes

videoTypes?: VideoType[]

Optional filter by VideoType (videofile, dvd, bluray, iso). Allows multiple, comma delimited.

Memberof

ItemsApiGetItems

`Optional` `Readonly`years

years?: number[]

Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimited.

Memberof

ItemsApiGetItems

Interface ItemsApiGetItemsRequest

Export

Index

Properties

Properties

Optional ReadonlyadjacentTo

Memberof

Optional ReadonlyalbumArtistIds

Memberof

Optional ReadonlyalbumIds

Memberof

Optional Readonlyalbums

Memberof

Optional ReadonlyartistIds

Memberof

Optional Readonlyartists

Memberof

Optional ReadonlycollapseBoxSetItems

Memberof

Optional ReadonlycontributingArtistIds

Memberof

Optional ReadonlyenableImages

Memberof

Optional ReadonlyenableImageTypes

Memberof

Optional ReadonlyenableTotalRecordCount

Memberof

Optional ReadonlyenableUserData

Memberof

Optional ReadonlyexcludeArtistIds

Memberof

Optional ReadonlyexcludeItemIds

Memberof

Optional ReadonlyexcludeItemTypes

Memberof

Optional ReadonlyexcludeLocationTypes

Memberof

Optional Readonlyfields

Memberof

Optional Readonlyfilters

Memberof

Optional ReadonlygenreIds

Memberof

Optional Readonlygenres

Memberof

Optional ReadonlyhasImdbId

Memberof

Optional ReadonlyhasOfficialRating

Memberof

Optional ReadonlyhasOverview

Memberof

Optional ReadonlyhasParentalRating

Memberof

Optional ReadonlyhasSpecialFeature

Memberof

Optional ReadonlyhasSubtitles

Memberof

Optional ReadonlyhasThemeSong

Memberof

Optional ReadonlyhasThemeVideo

Memberof

Optional ReadonlyhasTmdbId

Memberof

Optional ReadonlyhasTrailer

Memberof

Optional ReadonlyhasTvdbId

Memberof

Optional Readonlyids

Memberof

Optional ReadonlyimageTypeLimit

Memberof

Optional ReadonlyimageTypes

Memberof

Optional ReadonlyincludeItemTypes

Memberof

Optional ReadonlyindexNumber

Memberof

Optional Readonlyis3D

Memberof

Optional Readonlyis4K

`Optional` `Readonly`adjacentTo

`Optional` `Readonly`albumArtistIds

`Optional` `Readonly`albumIds

`Optional` `Readonly`albums

`Optional` `Readonly`artistIds

`Optional` `Readonly`artists

`Optional` `Readonly`collapseBoxSetItems

`Optional` `Readonly`contributingArtistIds

`Optional` `Readonly`enableImages

`Optional` `Readonly`enableImageTypes

`Optional` `Readonly`enableTotalRecordCount

`Optional` `Readonly`enableUserData

`Optional` `Readonly`excludeArtistIds

`Optional` `Readonly`excludeItemIds

`Optional` `Readonly`excludeItemTypes

`Optional` `Readonly`excludeLocationTypes

`Optional` `Readonly`fields

`Optional` `Readonly`filters

`Optional` `Readonly`genreIds

`Optional` `Readonly`genres

`Optional` `Readonly`hasImdbId

`Optional` `Readonly`hasOfficialRating

`Optional` `Readonly`hasOverview

`Optional` `Readonly`hasParentalRating

`Optional` `Readonly`hasSpecialFeature

`Optional` `Readonly`hasSubtitles

`Optional` `Readonly`hasThemeSong

`Optional` `Readonly`hasThemeVideo

`Optional` `Readonly`hasTmdbId

`Optional` `Readonly`hasTrailer

`Optional` `Readonly`hasTvdbId

`Optional` `Readonly`ids

`Optional` `Readonly`imageTypeLimit

`Optional` `Readonly`imageTypes

`Optional` `Readonly`includeItemTypes

`Optional` `Readonly`indexNumber

`Optional` `Readonly`is3D

`Optional` `Readonly`is4K

`Optional` `Readonly`isFavorite

`Optional` `Readonly`isHd

`Optional` `Readonly`isKids

`Optional` `Readonly`isLocked

`Optional` `Readonly`isMissing

`Optional` `Readonly`isMovie

`Optional` `Readonly`isNews

`Optional` `Readonly`isPlaceHolder

`Optional` `Readonly`isPlayed

`Optional` `Readonly`isSeries

`Optional` `Readonly`isSports

`Optional` `Readonly`isUnaired

`Optional` `Readonly`limit

`Optional` `Readonly`locationTypes

`Optional` `Readonly`maxHeight

`Optional` `Readonly`maxOfficialRating

`Optional` `Readonly`maxPremiereDate

`Optional` `Readonly`maxWidth

`Optional` `Readonly`mediaTypes

`Optional` `Readonly`minCommunityRating

`Optional` `Readonly`minCriticRating

`Optional` `Readonly`minDateLastSaved

`Optional` `Readonly`minDateLastSavedForUser

`Optional` `Readonly`minHeight

`Optional` `Readonly`minOfficialRating

`Optional` `Readonly`minPremiereDate

`Optional` `Readonly`minWidth

`Optional` `Readonly`nameLessThan

`Optional` `Readonly`nameStartsWith

`Optional` `Readonly`nameStartsWithOrGreater

`Optional` `Readonly`officialRatings

`Optional` `Readonly`parentId

`Optional` `Readonly`parentIndexNumber

`Optional` `Readonly`person

`Optional` `Readonly`personIds