jellyfin-api/org.jellyfin.sdk.api.operations/ItemsApi/getItems

getItems

suspend fun getItems(userId: <Error class: unknown class>? = null, maxOfficialRating: String? = null, hasThemeSong: Boolean? = null, hasThemeVideo: Boolean? = null, hasSubtitles: Boolean? = null, hasSpecialFeature: Boolean? = null, hasTrailer: Boolean? = null, adjacentTo: <Error class: unknown class>? = null, indexNumber: Int? = null, parentIndexNumber: Int? = null, hasParentalRating: Boolean? = null, isHd: Boolean? = null, is4k: Boolean? = null, locationTypes: Collection<<Error class: unknown class>>? = emptyList(), excludeLocationTypes: Collection<<Error class: unknown class>>? = emptyList(), isMissing: Boolean? = null, isUnaired: Boolean? = null, minCommunityRating: Double? = null, minCriticRating: Double? = null, minPremiereDate: <Error class: unknown class>? = null, minDateLastSaved: <Error class: unknown class>? = null, minDateLastSavedForUser: <Error class: unknown class>? = null, maxPremiereDate: <Error class: unknown class>? = null, hasOverview: Boolean? = null, hasImdbId: Boolean? = null, hasTmdbId: Boolean? = null, hasTvdbId: Boolean? = null, isMovie: Boolean? = null, isSeries: Boolean? = null, isNews: Boolean? = null, isKids: Boolean? = null, isSports: Boolean? = null, excludeItemIds: Collection<<Error class: unknown class>>? = emptyList(), startIndex: Int? = null, limit: Int? = null, recursive: Boolean? = null, searchTerm: String? = null, sortOrder: Collection<<Error class: unknown class>>? = emptyList(), parentId: <Error class: unknown class>? = null, fields: Collection<<Error class: unknown class>>? = emptyList(), excludeItemTypes: Collection<<Error class: unknown class>>? = emptyList(), includeItemTypes: Collection<<Error class: unknown class>>? = emptyList(), filters: Collection<<Error class: unknown class>>? = emptyList(), isFavorite: Boolean? = null, mediaTypes: Collection<<Error class: unknown class>>? = emptyList(), imageTypes: Collection<<Error class: unknown class>>? = emptyList(), sortBy: Collection<<Error class: unknown class>>? = emptyList(), isPlayed: Boolean? = null, genres: Collection<String>? = emptyList(), officialRatings: Collection<String>? = emptyList(), tags: Collection<String>? = emptyList(), years: Collection<Int>? = emptyList(), enableUserData: Boolean? = null, imageTypeLimit: Int? = null, enableImageTypes: Collection<<Error class: unknown class>>? = emptyList(), person: String? = null, personIds: Collection<<Error class: unknown class>>? = emptyList(), personTypes: Collection<String>? = emptyList(), studios: Collection<String>? = emptyList(), artists: Collection<String>? = emptyList(), excludeArtistIds: Collection<<Error class: unknown class>>? = emptyList(), artistIds: Collection<<Error class: unknown class>>? = emptyList(), albumArtistIds: Collection<<Error class: unknown class>>? = emptyList(), contributingArtistIds: Collection<<Error class: unknown class>>? = emptyList(), albums: Collection<String>? = emptyList(), albumIds: Collection<<Error class: unknown class>>? = emptyList(), ids: Collection<<Error class: unknown class>>? = emptyList(), videoTypes: Collection<<Error class: unknown class>>? = emptyList(), minOfficialRating: String? = null, isLocked: Boolean? = null, isPlaceHolder: Boolean? = null, hasOfficialRating: Boolean? = null, collapseBoxSetItems: Boolean? = null, minWidth: Int? = null, minHeight: Int? = null, maxWidth: Int? = null, maxHeight: Int? = null, is3d: Boolean? = null, seriesStatus: Collection<<Error class: unknown class>>? = emptyList(), nameStartsWithOrGreater: String? = null, nameStartsWith: String? = null, nameLessThan: String? = null, studioIds: Collection<<Error class: unknown class>>? = emptyList(), genreIds: Collection<<Error class: unknown class>>? = emptyList(), enableTotalRecordCount: Boolean? = true, enableImages: Boolean? = true): Response<<Error class: unknown class>>

Gets items based on a query.

Parameters

userId

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

maxOfficialRating

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

hasThemeSong

Optional filter by items with theme songs.

hasThemeVideo

Optional filter by items with theme videos.

hasSubtitles

Optional filter by items with subtitles.

hasSpecialFeature

Optional filter by items with special features.

hasTrailer

Optional filter by items with trailers.

adjacentTo

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

indexNumber

Optional filter by index number.

parentIndexNumber

Optional filter by parent index number.

hasParentalRating

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

isHd

Optional filter by items that are HD or not.

is4k

Optional filter by items that are 4K or not.

locationTypes

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

excludeLocationTypes

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

isMissing

Optional filter by items that are missing episodes or not.

isUnaired

Optional filter by items that are unaired episodes or not.

minCommunityRating

Optional filter by minimum community rating.

minCriticRating

Optional filter by minimum critic rating.

minPremiereDate

Optional. The minimum premiere date. Format = ISO.

minDateLastSaved

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

minDateLastSavedForUser

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

maxPremiereDate

Optional. The maximum premiere date. Format = ISO.

hasOverview

Optional filter by items that have an overview or not.

hasImdbId

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

hasTmdbId

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

hasTvdbId

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

isMovie

Optional filter for live tv movies.

isSeries

Optional filter for live tv series.

isNews

Optional filter for live tv news.

isKids

Optional filter for live tv kids.

isSports

Optional filter for live tv sports.

excludeItemIds

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

startIndex

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

limit

Optional. The maximum number of records to return.

recursive

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

searchTerm

Optional. Filter based on a search term.

sortOrder

Sort Order - Ascending, Descending.

parentId

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

fields

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.

excludeItemTypes

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

includeItemTypes

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

filters

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

isFavorite

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

mediaTypes

Optional filter by MediaType. Allows multiple, comma delimited.

imageTypes

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

sortBy

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.

isPlayed

Optional filter by items that are played, or not.

genres

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

officialRatings

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

tags

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

years

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

enableUserData

Optional, include user data.

imageTypeLimit

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

enableImageTypes

Optional. The image types to include in the output.

person

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

personIds

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

personTypes

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

studios

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

artists

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

excludeArtistIds

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

artistIds

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

albumArtistIds

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

contributingArtistIds

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

albums

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

albumIds

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

ids

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

videoTypes

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

minOfficialRating

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

isLocked

Optional filter by items that are locked.

isPlaceHolder

Optional filter by items that are placeholders.

hasOfficialRating

Optional filter by items that have official ratings.

collapseBoxSetItems

Whether or not to hide items behind their boxsets.

minWidth

Optional. Filter by the minimum width of the item.

minHeight

Optional. Filter by the minimum height of the item.

maxWidth

Optional. Filter by the maximum width of the item.

maxHeight

Optional. Filter by the maximum height of the item.

is3d

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

seriesStatus

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

nameStartsWithOrGreater

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

nameStartsWith

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

nameLessThan

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

studioIds

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

genreIds

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

enableTotalRecordCount

Optional. Enable the total record count.

enableImages

Optional, include image information in output.

suspend fun getItems(request: <Error class: unknown class> = GetItemsRequest()): Response<<Error class: unknown class>>

Gets items based on a query.

Parameters

request

The request parameters