getTags

Gets items based on a query.

Requires authentication as user

Request
get /Tags
Parameters
Name In Type Default Notes
ArtistType query

Artist or AlbumArtist
MaxOfficialRating query

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

Optional filter by items with theme songs.
HasThemeVideo query

Optional filter by items with theme videos.
HasSubtitles query

Optional filter by items with subtitles.
HasSpecialFeature query

Optional filter by items with special features.
HasTrailer query

Optional filter by items with trailers.
AdjacentTo query

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

Optional filter by minimum index number.
MinStartDate query

Optional. The minimum premiere date. Format = ISO
MaxStartDate query

Optional. The maximum premiere date. Format = ISO
MinEndDate query

Optional. The minimum premiere date. Format = ISO
MaxEndDate query

Optional. The maximum premiere date. Format = ISO
MinPlayers query

Optional filter by minimum number of game players.
MaxPlayers query

Optional filter by maximum number of game players.
ParentIndexNumber query

Optional filter by parent index number.
HasParentalRating query

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

Optional filter by items that are HD or not.
IsUnaired query

Optional filter by items that are unaired episodes or not.
MinCommunityRating query

Optional filter by minimum community rating.
MinCriticRating query

Optional filter by minimum critic rating.
AiredDuringSeason query

Gets all episodes that aired during a season, including specials.
MinPremiereDate query

Optional. The minimum premiere date. Format = ISO
MinDateLastSaved query

Optional. The minimum premiere date. Format = ISO
MinDateLastSavedForUser query

Optional. The minimum premiere date. Format = ISO
MaxPremiereDate query

Optional. The maximum premiere date. Format = ISO
HasOverview query

Optional filter by items that have an overview or not.
HasImdbId query

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

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

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

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

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

Optional. The maximum number of records to return
Recursive query

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

Enter a search term to perform a search request
SortOrder query

Sort Order - Ascending,Descending
ParentId query

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

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
ExcludeItemTypes query

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

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

Optional. If specified, result will be filtered to contain only items which match at least one of the specified IDs. Each provider ID must be in the form 'prov.id', e.g. 'imdb.tt123456'. This allows multiple, comma delimeted value pairs.
Filters query

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

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

Optional filter for movies.
IsSeries query

Optional filter for series.
IsFolder query

Optional filter for folders.
IsNews query

Optional filter for news.
IsKids query

Optional filter for kids.
IsSports query

Optional filter for sports.
IsNew query

Optional filter for IsNew.
IsPremiere query

Optional filter for IsPremiere.
IsNewOrPremiere query

Optional filter for IsNewOrPremiere.
IsRepeat query

Optional filter for IsRepeat.
ProjectToMedia query

ProjectToMedia
MediaTypes query

Optional filter by MediaType. Allows multiple, comma delimited.
ImageTypes query

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

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
IsPlayed query

Optional filter by items that are played, or not.
Genres query

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

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

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

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

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

Optional, include image information in output
EnableUserData query

Optional, include user data
ImageTypeLimit query

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

Optional. The image types to include in the output.
Person query

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

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

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 query

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

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

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

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

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

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

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

Optional filter by Container. Allows multiple, comma delimeted.
AudioCodecs query

Optional filter by AudioCodec. Allows multiple, comma delimeted.
AudioLayouts query

Optional filter by AudioLayout. Allows multiple, comma delimeted.
VideoCodecs query

Optional filter by VideoCodec. Allows multiple, comma delimeted.
ExtendedVideoTypes query

Optional filter by ExtendedVideoType. Allows multiple, comma delimeted.
SubtitleCodecs query

Optional filter by SubtitleCodec. Allows multiple, comma delimeted.
Path query

Optional filter by Path.
UserId query

User Id
MinOfficialRating query

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

Optional filter by items that are locked.
IsPlaceHolder query

Optional filter by items that are placeholders
HasOfficialRating query

Optional filter by items that have official ratings
GroupItemsIntoCollections query

Whether or not to hide items behind their boxsets.
Is3D query

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

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

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

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

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

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

Optional filter by items whose name is equally or lesser than a given input string.
Responses
Status Code Type Description Samples
200 TagItem

Operation successful. Returning a QueryResult object.
400

Bad Request. Server cannot process request.
401

Unauthorized. Client needs to authenticate.
403

Forbidden. No permission for the reqested operation.
404

Resource not found or unavailable.
500

Server error.

Definitions

TagItem

QueryResult_UserLibrary.TagItem
Name Type Notes
Items TagItem[]
TotalRecordCount integer (int32)

TagItem

Emby.Api.UserLibrary.TagItem
Name Type Notes
Name string
Id string