Type Alias GetItemsData

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

Index

Properties

body? path? query? url

Properties

`Optional`body

body?: never

`Optional`path

path?: never

`Optional`query

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

Type Declaration

OptionaluserId?: string

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

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

Optional filter by items with theme songs.
OptionalhasThemeVideo?: boolean

Optional filter by items with theme videos.
OptionalhasSubtitles?: boolean

Optional filter by items with subtitles.
OptionalhasSpecialFeature?: boolean

Optional filter by items with special features.
OptionalhasTrailer?: boolean

Optional filter by items with trailers.
OptionaladjacentTo?: string

Optional. Return items that are siblings of a supplied item.
OptionalindexNumber?: number

Optional filter by index number.
OptionalparentIndexNumber?: number

Optional filter by parent index number.
OptionalhasParentalRating?: boolean

Optional filter by items that have or do not have a parental rating.
OptionalisHd?: boolean

Optional filter by items that are HD or not.
Optionalis4K?: boolean

Optional filter by items that are 4K or not.
OptionallocationTypes?: LocationType[]

Optional. If specified, results will be filtered based on LocationType. This allows multiple, comma delimited.
OptionalexcludeLocationTypes?: LocationType[]

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

Optional filter by items that are missing episodes or not.
OptionalisUnaired?: boolean

Optional filter by items that are unaired episodes or not.
OptionalminCommunityRating?: number

Optional filter by minimum community rating.
OptionalminCriticRating?: number

Optional filter by minimum critic rating.
OptionalminPremiereDate?: string

Optional. The minimum premiere date. Format = ISO.
OptionalminDateLastSaved?: string

Optional. The minimum last saved date. Format = ISO.
OptionalminDateLastSavedForUser?: string

Optional. The minimum last saved date for the current user. Format = ISO.
OptionalmaxPremiereDate?: string

Optional. The maximum premiere date. Format = ISO.
OptionalhasOverview?: boolean

Optional filter by items that have an overview or not.
OptionalhasImdbId?: boolean

Optional filter by items that have an IMDb id or not.
OptionalhasTmdbId?: boolean

Optional filter by items that have a TMDb id or not.
OptionalhasTvdbId?: boolean

Optional filter by items that have a TVDb id or not.
OptionalisMovie?: boolean

Optional filter for live tv movies.
OptionalisSeries?: boolean

Optional filter for live tv series.
OptionalisNews?: boolean

Optional filter for live tv news.
OptionalisKids?: boolean

Optional filter for live tv kids.
OptionalisSports?: boolean

Optional filter for live tv sports.
OptionalexcludeItemIds?: string[]

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

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

Optional. The maximum number of records to return.
Optionalrecursive?: boolean

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

Optional. Filter based on a search term.
OptionalsortOrder?: SortOrder[]

Sort Order - Ascending, Descending.
OptionalparentId?: string

Specify this to localize the search to a specific item or folder. Omit to use the root.
Optionalfields?: 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.
OptionalexcludeItemTypes?: BaseItemKind[]

Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
OptionalincludeItemTypes?: BaseItemKind[]

Optional. If specified, results will be filtered based on the item type. This allows multiple, comma delimited.
Optionalfilters?: ItemFilter[]

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

Optional filter by items that are marked as favorite, or not.
OptionalmediaTypes?: MediaType[]

Optional filter by MediaType. Allows multiple, comma delimited.
OptionalimageTypes?: ImageType[]

Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited.
OptionalsortBy?: 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.
OptionalisPlayed?: boolean

Optional filter by items that are played, or not.
Optionalgenres?: string[]

Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
OptionalofficialRatings?: string[]

Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
Optionaltags?: string[]

Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited.
Optionalyears?: number[]

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

Optional, include user data.
OptionalimageTypeLimit?: number

Optional, the max number of images to return, per image type.
OptionalenableImageTypes?: ImageType[]

Optional. The image types to include in the output.
Optionalperson?: string

Optional. If specified, results will be filtered to include only those containing the specified person.
OptionalpersonIds?: string[]

Optional. If specified, results will be filtered to include only those containing the specified person id.
OptionalpersonTypes?: 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.
Optionalstudios?: string[]

Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited.
Optionalartists?: string[]

Optional. If specified, results will be filtered based on artists. This allows multiple, pipe delimited.
OptionalexcludeArtistIds?: string[]

Optional. If specified, results will be filtered based on artist id. This allows multiple, pipe delimited.
OptionalartistIds?: string[]

Optional. If specified, results will be filtered to include only those containing the specified artist id.
OptionalalbumArtistIds?: string[]

Optional. If specified, results will be filtered to include only those containing the specified album artist id.
OptionalcontributingArtistIds?: string[]

Optional. If specified, results will be filtered to include only those containing the specified contributing artist id.
Optionalalbums?: string[]

Optional. If specified, results will be filtered based on album. This allows multiple, pipe delimited.
OptionalalbumIds?: string[]

Optional. If specified, results will be filtered based on album id. This allows multiple, pipe delimited.
Optionalids?: string[]

Optional. If specific items are needed, specify a list of item id's to retrieve. This allows multiple, comma delimited.
OptionalvideoTypes?: VideoType[]

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

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

Optional filter by items that are locked.
OptionalisPlaceHolder?: boolean

Optional filter by items that are placeholders.
OptionalhasOfficialRating?: boolean

Optional filter by items that have official ratings.
OptionalcollapseBoxSetItems?: boolean

Whether or not to hide items behind their boxsets.
OptionalminWidth?: number

Optional. Filter by the minimum width of the item.
OptionalminHeight?: number

Optional. Filter by the minimum height of the item.
OptionalmaxWidth?: number

Optional. Filter by the maximum width of the item.
OptionalmaxHeight?: number

Optional. Filter by the maximum height of the item.
Optionalis3D?: boolean

Optional filter by items that are 3D, or not.
OptionalseriesStatus?: SeriesStatus[]

Optional filter by Series Status. Allows multiple, comma delimited.
OptionalnameStartsWithOrGreater?: string

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

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

Optional filter by items whose name is equally or lesser than a given input string.
OptionalstudioIds?: string[]

Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimited.
OptionalgenreIds?: string[]

Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.
OptionalaudioLanguages?: string[]

Optional. If specified, results will be filtered based on audio language. This allows multiple, comma delimited values.
OptionalsubtitleLanguages?: string[]

Optional. If specified, results will be filtered based on subtitle language. This allows multiple, comma delimited values.
OptionalenableTotalRecordCount?: boolean

Optional. Enable the total record count.
OptionalenableImages?: boolean

Optional, include image information in output.

url

url: "/Items"

Type Alias GetItemsData

Index

Properties

Properties

Optionalbody

Optionalpath

Optionalquery

Type Declaration

OptionaluserId?: string

OptionalmaxOfficialRating?: string

OptionalhasThemeSong?: boolean

OptionalhasThemeVideo?: boolean

OptionalhasSubtitles?: boolean

OptionalhasSpecialFeature?: boolean

OptionalhasTrailer?: boolean

OptionaladjacentTo?: string

OptionalindexNumber?: number

OptionalparentIndexNumber?: number

OptionalhasParentalRating?: boolean

OptionalisHd?: boolean

Optionalis4K?: boolean

OptionallocationTypes?: LocationType[]

OptionalexcludeLocationTypes?: LocationType[]

OptionalisMissing?: boolean

OptionalisUnaired?: boolean

OptionalminCommunityRating?: number

OptionalminCriticRating?: number

OptionalminPremiereDate?: string

OptionalminDateLastSaved?: string

OptionalminDateLastSavedForUser?: string

OptionalmaxPremiereDate?: string

OptionalhasOverview?: boolean

OptionalhasImdbId?: boolean

OptionalhasTmdbId?: boolean

OptionalhasTvdbId?: boolean

OptionalisMovie?: boolean

OptionalisSeries?: boolean

OptionalisNews?: boolean

OptionalisKids?: boolean

OptionalisSports?: boolean

OptionalexcludeItemIds?: string[]

OptionalstartIndex?: number

Optionallimit?: number

Optionalrecursive?: boolean

OptionalsearchTerm?: string

OptionalsortOrder?: SortOrder[]

OptionalparentId?: string

Optionalfields?: ItemFields[]

OptionalexcludeItemTypes?: BaseItemKind[]

OptionalincludeItemTypes?: BaseItemKind[]

Optionalfilters?: ItemFilter[]

OptionalisFavorite?: boolean

OptionalmediaTypes?: MediaType[]

OptionalimageTypes?: ImageType[]

OptionalsortBy?: ItemSortBy[]

OptionalisPlayed?: boolean

Optionalgenres?: string[]

OptionalofficialRatings?: string[]

Optionaltags?: string[]

Optionalyears?: number[]

OptionalenableUserData?: boolean

OptionalimageTypeLimit?: number

OptionalenableImageTypes?: ImageType[]

Optionalperson?: string

OptionalpersonIds?: string[]

OptionalpersonTypes?: string[]

Optionalstudios?: string[]

Optionalartists?: string[]

OptionalexcludeArtistIds?: string[]

OptionalartistIds?: string[]

OptionalalbumArtistIds?: string[]

OptionalcontributingArtistIds?: string[]

Optionalalbums?: string[]

OptionalalbumIds?: string[]

Optionalids?: string[]

OptionalvideoTypes?: VideoType[]

OptionalminOfficialRating?: string

OptionalisLocked?: boolean

OptionalisPlaceHolder?: boolean

OptionalhasOfficialRating?: boolean

`Optional`body

`Optional`path

`Optional`query

`Optional`userId?: string

`Optional`maxOfficialRating?: string

`Optional`hasThemeSong?: boolean

`Optional`hasThemeVideo?: boolean

`Optional`hasSubtitles?: boolean

`Optional`hasSpecialFeature?: boolean

`Optional`hasTrailer?: boolean

`Optional`adjacentTo?: string

`Optional`indexNumber?: number

`Optional`parentIndexNumber?: number

`Optional`hasParentalRating?: boolean

`Optional`isHd?: boolean

`Optional`is4K?: boolean

`Optional`locationTypes?: LocationType[]

`Optional`excludeLocationTypes?: LocationType[]

`Optional`isMissing?: boolean

`Optional`isUnaired?: boolean

`Optional`minCommunityRating?: number

`Optional`minCriticRating?: number

`Optional`minPremiereDate?: string

`Optional`minDateLastSaved?: string

`Optional`minDateLastSavedForUser?: string

`Optional`maxPremiereDate?: string

`Optional`hasOverview?: boolean

`Optional`hasImdbId?: boolean

`Optional`hasTmdbId?: boolean

`Optional`hasTvdbId?: boolean

`Optional`isMovie?: boolean

`Optional`isSeries?: boolean

`Optional`isNews?: boolean

`Optional`isKids?: boolean

`Optional`isSports?: boolean

`Optional`excludeItemIds?: string[]

`Optional`startIndex?: number

`Optional`limit?: number

`Optional`recursive?: boolean

`Optional`searchTerm?: string

`Optional`sortOrder?: SortOrder[]

`Optional`parentId?: string

`Optional`fields?: ItemFields[]

`Optional`excludeItemTypes?: BaseItemKind[]

`Optional`includeItemTypes?: BaseItemKind[]

`Optional`filters?: ItemFilter[]

`Optional`isFavorite?: boolean

`Optional`mediaTypes?: MediaType[]

`Optional`imageTypes?: ImageType[]

`Optional`sortBy?: ItemSortBy[]

`Optional`isPlayed?: boolean

`Optional`genres?: string[]

`Optional`officialRatings?: string[]

`Optional`tags?: string[]

`Optional`years?: number[]

`Optional`enableUserData?: boolean

`Optional`imageTypeLimit?: number

`Optional`enableImageTypes?: ImageType[]

`Optional`person?: string

`Optional`personIds?: string[]

`Optional`personTypes?: string[]

`Optional`studios?: string[]

`Optional`artists?: string[]

`Optional`excludeArtistIds?: string[]

`Optional`artistIds?: string[]

`Optional`albumArtistIds?: string[]

`Optional`contributingArtistIds?: string[]

`Optional`albums?: string[]

`Optional`albumIds?: string[]

`Optional`ids?: string[]

`Optional`videoTypes?: VideoType[]

`Optional`minOfficialRating?: string

`Optional`isLocked?: boolean

`Optional`isPlaceHolder?: boolean

`Optional`hasOfficialRating?: boolean

`Optional`collapseBoxSetItems?: boolean

`Optional`minWidth?: number

`Optional`minHeight?: number

`Optional`maxWidth?: number

`Optional`maxHeight?: number