JEjellyfin
Items

Gets items based on a query.

get/Users/{userId}/Items

Request

Path parameters

userIdstring uuid required

The user id supplied as query parameter.

Query parameters

maxOfficialRatingstring nullable

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

hasThemeSongboolean nullable

Optional filter by items with theme songs.

hasThemeVideoboolean nullable

Optional filter by items with theme videos.

hasSubtitlesboolean nullable

Optional filter by items with subtitles.

hasSpecialFeatureboolean nullable

Optional filter by items with special features.

hasTrailerboolean nullable

Optional filter by items with trailers.

adjacentTostring nullable

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

parentIndexNumberinteger nullable

Optional filter by parent index number.

hasParentalRatingboolean nullable

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

isHdboolean nullable

Optional filter by items that are HD or not.

is4Kboolean nullable

Optional filter by items that are 4K or not.

locationTypesLocationType[] nullable

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

excludeLocationTypesLocationType[] nullable

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

isMissingboolean nullable

Optional filter by items that are missing episodes or not.

isUnairedboolean nullable

Optional filter by items that are unaired episodes or not.

minCommunityRatingnumber double nullable

Optional filter by minimum community rating.

minCriticRatingnumber double nullable

Optional filter by minimum critic rating.

minPremiereDatestring date-time nullable

Optional. The minimum premiere date. Format = ISO.

minDateLastSavedstring date-time nullable

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

minDateLastSavedForUserstring date-time nullable

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

maxPremiereDatestring date-time nullable

Optional. The maximum premiere date. Format = ISO.

hasOverviewboolean nullable

Optional filter by items that have an overview or not.

hasImdbIdboolean nullable

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

hasTmdbIdboolean nullable

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

hasTvdbIdboolean nullable

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

excludeItemIdsstring[] nullable

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

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.

recursiveboolean nullable

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

searchTermstring nullable

Optional. Filter based on a search term.

sortOrderstring nullable

Sort Order - Ascending,Descending.

parentIdstring uuid nullable

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

fieldsItemFields[] nullable

Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimeted. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines.

excludeItemTypesstring[] nullable

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

includeItemTypesstring[] nullable

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

filtersItemFilter[] nullable

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

isFavoriteboolean nullable

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

mediaTypesstring[] nullable

Optional filter by MediaType. Allows multiple, comma delimited.

imageTypesImageType[] nullable

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

sortBystring nullable

Optional. Specify one or more sort orders, comma delimeted. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.

isPlayedboolean nullable

Optional filter by items that are played, or not.

genresstring[] nullable

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

officialRatingsstring[] nullable

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

tagsstring[] nullable

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

yearsinteger[] nullable

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

enableUserDataboolean nullable

Optional, include user data.

imageTypeLimitinteger nullable

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

enableImageTypesImageType[] nullable

Optional. The image types to include in the output.

personstring nullable

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

personIdsstring[] nullable

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

personTypesstring[] nullable

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

studiosstring[] nullable

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

artistsstring[] nullable

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

excludeArtistIdsstring[] nullable

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

artistIdsstring[] nullable

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

albumArtistIdsstring[] nullable

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

contributingArtistIdsstring[] nullable

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

albumsstring[] nullable

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

albumIdsstring[] nullable

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

idsstring[] nullable

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

videoTypesVideoType[] nullable

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

minOfficialRatingstring nullable

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

isLockedboolean nullable

Optional filter by items that are locked.

isPlaceHolderboolean nullable

Optional filter by items that are placeholders.

hasOfficialRatingboolean nullable

Optional filter by items that have official ratings.

collapseBoxSetItemsboolean nullable

Whether or not to hide items behind their boxsets.

minWidthinteger nullable

Optional. Filter by the minimum width of the item.

minHeightinteger nullable

Optional. Filter by the minimum height of the item.

maxWidthinteger nullable

Optional. Filter by the maximum width of the item.

maxHeightinteger nullable

Optional. Filter by the maximum height of the item.

is3Dboolean nullable

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

seriesStatusSeriesStatus[] nullable

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

nameStartsWithOrGreaterstring nullable

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

nameStartsWithstring nullable

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

nameLessThanstring nullable

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

studioIdsstring[] nullable

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

genreIdsstring[] nullable

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

enableTotalRecordCountboolean

Optional. Enable the total record count.

enableImagesboolean nullable

Optional, include image information in output.

Response

Success

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.