JEjellyfin
Search

Gets the search hint result.

get/Search/Hints

Request

Query parameters

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.

userIdstring uuid nullable

Optional. Supply a user id to search within a user's library or omit to search all.

searchTermstring required

The search term to filter on.

includeItemTypesstring[] nullable

If specified, only results with the specified item types are returned. This allows multiple, comma delimeted.

excludeItemTypesstring[] nullable

If specified, results with these item types are filtered out. This allows multiple, comma delimeted.

mediaTypesstring[] nullable

If specified, only results with the specified media types are returned. This allows multiple, comma delimeted.

parentIdstring uuid nullable

If specified, only children of the parent are returned.

isMovieboolean nullable

Optional filter for movies.

isSeriesboolean nullable

Optional filter for series.

isNewsboolean nullable

Optional filter for news.

isKidsboolean nullable

Optional filter for kids.

isSportsboolean nullable

Optional filter for sports.

includePeopleboolean

Optional filter whether to include people.

includeMediaboolean

Optional filter whether to include media.

includeGenresboolean

Optional filter whether to include genres.

includeStudiosboolean

Optional filter whether to include studios.

includeArtistsboolean

Optional filter whether to include artists.

Response

Search hint returned.

TotalRecordCountinteger

Gets or sets the total record count.

Changes

No recorded changes to this operation across all 1 revision of this API.