---
title: "Gets the search hint result."
method: GET
path: "/Search/Hints"
tags: ["Search"]
---

# Gets the search hint result.

`GET /Search/Hints`

## Query parameters

- `startIndex` integer, nullable — Optional. The record index to start at. All items with a lower index will be dropped from the results.
- `limit` integer, nullable — Optional. The maximum number of records to return.
- `userId` string, uuid, nullable — Optional. Supply a user id to search within a user's library or omit to search all.
- `searchTerm` string, required — The search term to filter on.
- `includeItemTypes` string[], nullable — If specified, only results with the specified item types are returned. This allows multiple, comma delimeted.
- `excludeItemTypes` string[], nullable — If specified, results with these item types are filtered out. This allows multiple, comma delimeted.
- `mediaTypes` string[], nullable — If specified, only results with the specified media types are returned. This allows multiple, comma delimeted.
- `parentId` string, uuid, nullable — If specified, only children of the parent are returned.
- `isMovie` boolean, nullable — Optional filter for movies.
- `isSeries` boolean, nullable — Optional filter for series.
- `isNews` boolean, nullable — Optional filter for news.
- `isKids` boolean, nullable — Optional filter for kids.
- `isSports` boolean, nullable — Optional filter for sports.
- `includePeople` boolean — Optional filter whether to include people.
- `includeMedia` boolean — Optional filter whether to include media.
- `includeGenres` boolean — Optional filter whether to include genres.
- `includeStudios` boolean — Optional filter whether to include studios.
- `includeArtists` boolean — Optional filter whether to include artists.

## Response `200`

Search hint returned.

- SearchHintResult — Class SearchHintResult.
  - `SearchHints` SearchHint[], nullable — Gets or sets the search hints.
    - `ItemId` string, uuid — Gets or sets the item id.
    - `Id` string, uuid
    - `Name` string, nullable — Gets or sets the name.
    - `MatchedTerm` string, nullable — Gets or sets the matched term.
    - `IndexNumber` integer, nullable — Gets or sets the index number.
    - `ProductionYear` integer, nullable — Gets or sets the production year.
    - `ParentIndexNumber` integer, nullable — Gets or sets the parent index number.
    - `PrimaryImageTag` string, nullable — Gets or sets the image tag.
    - `ThumbImageTag` string, nullable — Gets or sets the thumb image tag.
    - `ThumbImageItemId` string, nullable — Gets or sets the thumb image item identifier.
    - `BackdropImageTag` string, nullable — Gets or sets the backdrop image tag.
    - `BackdropImageItemId` string, nullable — Gets or sets the backdrop image item identifier.
    - `Type` string, nullable — Gets or sets the type.
    - `IsFolder` boolean, nullable
    - `RunTimeTicks` integer, nullable — Gets or sets the run time ticks.
    - `MediaType` string, nullable — Gets or sets the type of the media.
    - `StartDate` string, date-time, nullable
    - `EndDate` string, date-time, nullable
    - `Series` string, nullable — Gets or sets the series.
    - `Status` string, nullable
    - `Album` string, nullable — Gets or sets the album.
    - `AlbumId` string, uuid
    - `AlbumArtist` string, nullable — Gets or sets the album artist.
    - `Artists` string[], nullable — Gets or sets the artists.
    - `SongCount` integer, nullable — Gets or sets the song count.
    - `EpisodeCount` integer, nullable — Gets or sets the episode count.
    - `ChannelId` string, uuid — Gets or sets the channel identifier.
    - `ChannelName` string, nullable — Gets or sets the name of the channel.
    - `PrimaryImageAspectRatio` number, double, nullable — Gets or sets the primary image aspect ratio.
  - `TotalRecordCount` integer — Gets or sets the total record count.

## Other responses

- `401` — Unauthorized
- `403` — Forbidden

---

[API](https://skmtc.net/jellyfin/apis/jellyfin-api.md) · [All operations](https://skmtc.net/jellyfin/apis/jellyfin-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/jellyfin/jellyfin-api/revisions/eb6f75af7066/schema)