@jellyfin/sdk
    Preparing search index...

    Interface ItemsApiGetItemsRequest

    Request parameters for getItems operation in ItemsApi.

    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

    adjacentTo?: string

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

    ItemsApiGetItems

    albumArtistIds?: string[]

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

    ItemsApiGetItems

    albumIds?: string[]

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

    ItemsApiGetItems

    albums?: string[]

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

    ItemsApiGetItems

    artistIds?: string[]

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

    ItemsApiGetItems

    artists?: string[]

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

    ItemsApiGetItems

    collapseBoxSetItems?: boolean

    Whether or not to hide items behind their boxsets.

    ItemsApiGetItems

    contributingArtistIds?: string[]

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

    ItemsApiGetItems

    enableImages?: boolean

    Optional, include image information in output.

    ItemsApiGetItems

    enableImageTypes?: ImageType[]

    Optional. The image types to include in the output.

    ItemsApiGetItems

    enableTotalRecordCount?: boolean

    Optional. Enable the total record count.

    ItemsApiGetItems

    enableUserData?: boolean

    Optional, include user data.

    ItemsApiGetItems

    excludeArtistIds?: string[]

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

    ItemsApiGetItems

    excludeItemIds?: string[]

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

    ItemsApiGetItems

    excludeItemTypes?: BaseItemKind[]

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

    ItemsApiGetItems

    excludeLocationTypes?: LocationType[]

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

    ItemsApiGetItems

    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.

    ItemsApiGetItems

    filters?: ItemFilter[]

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

    ItemsApiGetItems

    genreIds?: string[]

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

    ItemsApiGetItems

    genres?: string[]

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

    ItemsApiGetItems

    hasImdbId?: boolean

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

    ItemsApiGetItems

    hasOfficialRating?: boolean

    Optional filter by items that have official ratings.

    ItemsApiGetItems

    hasOverview?: boolean

    Optional filter by items that have an overview or not.

    ItemsApiGetItems

    hasParentalRating?: boolean

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

    ItemsApiGetItems

    hasSpecialFeature?: boolean

    Optional filter by items with special features.

    ItemsApiGetItems

    hasSubtitles?: boolean

    Optional filter by items with subtitles.

    ItemsApiGetItems

    hasThemeSong?: boolean

    Optional filter by items with theme songs.

    ItemsApiGetItems

    hasThemeVideo?: boolean

    Optional filter by items with theme videos.

    ItemsApiGetItems

    hasTmdbId?: boolean

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

    ItemsApiGetItems

    hasTrailer?: boolean

    Optional filter by items with trailers.

    ItemsApiGetItems

    hasTvdbId?: boolean

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

    ItemsApiGetItems

    ids?: string[]

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

    ItemsApiGetItems

    imageTypeLimit?: number

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

    ItemsApiGetItems

    imageTypes?: ImageType[]

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

    ItemsApiGetItems

    includeItemTypes?: BaseItemKind[]

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

    ItemsApiGetItems

    indexNumber?: number

    Optional filter by index number.

    ItemsApiGetItems

    is3D?: boolean

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

    ItemsApiGetItems

    is4K?: boolean

    Optional filter by items that are 4K or not.

    ItemsApiGetItems

    isFavorite?: boolean

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

    ItemsApiGetItems

    isHd?: boolean

    Optional filter by items that are HD or not.

    ItemsApiGetItems

    isKids?: boolean

    Optional filter for live tv kids.

    ItemsApiGetItems

    isLocked?: boolean

    Optional filter by items that are locked.

    ItemsApiGetItems

    isMissing?: boolean

    Optional filter by items that are missing episodes or not.

    ItemsApiGetItems

    isMovie?: boolean

    Optional filter for live tv movies.

    ItemsApiGetItems

    isNews?: boolean

    Optional filter for live tv news.

    ItemsApiGetItems

    isPlaceHolder?: boolean

    Optional filter by items that are placeholders.

    ItemsApiGetItems

    isPlayed?: boolean

    Optional filter by items that are played, or not.

    ItemsApiGetItems

    isSeries?: boolean

    Optional filter for live tv series.

    ItemsApiGetItems

    isSports?: boolean

    Optional filter for live tv sports.

    ItemsApiGetItems

    isUnaired?: boolean

    Optional filter by items that are unaired episodes or not.

    ItemsApiGetItems

    limit?: number

    Optional. The maximum number of records to return.

    ItemsApiGetItems

    locationTypes?: LocationType[]

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

    ItemsApiGetItems

    maxHeight?: number

    Optional. Filter by the maximum height of the item.

    ItemsApiGetItems

    maxOfficialRating?: string

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

    ItemsApiGetItems

    maxPremiereDate?: string

    Optional. The maximum premiere date. Format = ISO.

    ItemsApiGetItems

    maxWidth?: number

    Optional. Filter by the maximum width of the item.

    ItemsApiGetItems

    mediaTypes?: MediaType[]

    Optional filter by MediaType. Allows multiple, comma delimited.

    ItemsApiGetItems

    minCommunityRating?: number

    Optional filter by minimum community rating.

    ItemsApiGetItems

    minCriticRating?: number

    Optional filter by minimum critic rating.

    ItemsApiGetItems

    minDateLastSaved?: string

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

    ItemsApiGetItems

    minDateLastSavedForUser?: string

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

    ItemsApiGetItems

    minHeight?: number

    Optional. Filter by the minimum height of the item.

    ItemsApiGetItems

    minOfficialRating?: string

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

    ItemsApiGetItems

    minPremiereDate?: string

    Optional. The minimum premiere date. Format = ISO.

    ItemsApiGetItems

    minWidth?: number

    Optional. Filter by the minimum width of the item.

    ItemsApiGetItems

    nameLessThan?: string

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

    ItemsApiGetItems

    nameStartsWith?: string

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

    ItemsApiGetItems

    nameStartsWithOrGreater?: string

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

    ItemsApiGetItems

    officialRatings?: string[]

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

    ItemsApiGetItems

    parentId?: string

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

    ItemsApiGetItems

    parentIndexNumber?: number

    Optional filter by parent index number.

    ItemsApiGetItems

    person?: string

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

    ItemsApiGetItems

    personIds?: string[]

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

    ItemsApiGetItems

    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.

    ItemsApiGetItems

    recursive?: boolean

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

    ItemsApiGetItems

    searchTerm?: string

    Optional. Filter based on a search term.

    ItemsApiGetItems

    seriesStatus?: SeriesStatus[]

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

    ItemsApiGetItems

    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.

    ItemsApiGetItems

    sortOrder?: SortOrder[]

    Sort Order - Ascending, Descending.

    ItemsApiGetItems

    startIndex?: number

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

    ItemsApiGetItems

    studioIds?: string[]

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

    ItemsApiGetItems

    studios?: string[]

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

    ItemsApiGetItems

    tags?: string[]

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

    ItemsApiGetItems

    userId?: string

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

    ItemsApiGetItems

    videoTypes?: VideoType[]

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

    ItemsApiGetItems

    years?: number[]

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

    ItemsApiGetItems

    Settings

    Member Visibility

    On This Page

    Properties
    adjacentToalbumArtistIdsalbumIdsalbumsartistIdsartistscollapseBoxSetItemscontributingArtistIdsenableImagesenableImageTypesenableTotalRecordCountenableUserDataexcludeArtistIdsexcludeItemIdsexcludeItemTypesexcludeLocationTypesfieldsfiltersgenreIdsgenreshasImdbIdhasOfficialRatinghasOverviewhasParentalRatinghasSpecialFeaturehasSubtitleshasThemeSonghasThemeVideohasTmdbIdhasTrailerhasTvdbIdidsimageTypeLimitimageTypesincludeItemTypesindexNumberis3Dis4KisFavoriteisHdisKidsisLockedisMissingisMovieisNewsisPlaceHolderisPlayedisSeriesisSportsisUnairedlimitlocationTypesmaxHeightmaxOfficialRatingmaxPremiereDatemaxWidthmediaTypesminCommunityRatingminCriticRatingminDateLastSavedminDateLastSavedForUserminHeightminOfficialRatingminPremiereDateminWidthnameLessThannameStartsWithnameStartsWithOrGreaterofficialRatingsparentIdparentIndexNumberpersonpersonIdspersonTypesrecursivesearchTermseriesStatussortBysortOrderstartIndexstudioIdsstudiostagsuserIdvideoTypesyears