---
title: "Searches against different entities in the system against a query string"
method: GET
path: "/api/Search/search"
tags: ["Search"]
---

# Searches against different entities in the system against a query string

`GET /api/Search/search`

## Query parameters

- `queryString` string
- `includeChapterAndFiles` boolean

## Response `200`

OK

- SearchResultGroupDto
  - `libraries` LibraryDto[], nullable
    - `id` integer
    - `name` string, nullable
    - `type` 0 | 1 | 2 | 3 | 4 | 5 — Members: - `0` — Manga - `1` — Comic (Flexible) (Comic) - `2` — Book - `3` — Image - `4` — Light Novel (LightNovel) - `5` — Comic (ComicVine)
    - `lastScanned` string, date-time
    - `coverImage` string, nullable
    - `folderWatching` boolean
    - `includeInDashboard` boolean
    - `includeInRecommended` boolean
    - `manageCollections` boolean
    - `manageReadingLists` boolean
    - `includeInSearch` boolean
    - `allowScrobbling` boolean
    - `folders` string[], nullable
    - `collapseSeriesRelationships` boolean
    - `libraryFileTypes` FileTypeGroup[], nullable
    - `excludePatterns` string[], nullable
    - `allowMetadataMatching` boolean
    - `enableMetadata` boolean
    - `removePrefixForSortName` boolean
    - `inheritWebLinksFromFirstChapter` boolean
    - `defaultLanguage` string, nullable
  - `series` SearchResultDto[], nullable
    - `seriesId` integer
    - `name` string, nullable
    - `originalName` string, nullable
    - `sortName` string, nullable
    - `localizedName` string, nullable
    - `format` 0 | 1 | 2 | 3 | 4 — Members: - `0` — Image - `1` — Archive - `2` — Unknown - `3` — EPUB (Epub) - `4` — PDF (Pdf)
    - `libraryName` string, nullable
    - `libraryId` integer
    - `releaseYear` integer
    - `volumeCount` integer
    - `chapterCount` integer
  - `collections` AppUserCollectionDto[], nullable
    - `id` integer
    - `title` string, nullable
    - `summary` string, nullable
    - `promoted` boolean
    - `ageRating` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | -1 — Members: - `0` — Unknown - `1` — Rating Pending (RatingPending) - `2` — Early Childhood (EarlyChildhood) - `3` — Everyone - `4` — G - `5` — Everyone 10+ (Everyone10Plus) - `6` — PG - `7` — Kids to Adults (KidsToAdults) - `8` — Teen - `9` — MA15+ (Mature15Plus) - `10` — Mature 17+ (Mature17Plus) - `11` — M (Mature) - `12` — R18+ (R18Plus) - `13` — Adults Only 18+ (AdultsOnly) - `14` — X18+ (X18Plus) - `-1` — Not Applicable (NotApplicable)
    - `coverImage` string, nullable
    - `primaryColor` string, nullable
    - `secondaryColor` string, nullable
    - `coverImageLocked` boolean
    - `itemCount` integer
    - `owner` string, nullable
    - `lastSyncUtc` string, date-time
    - `source` 0 | 1 | 2 | 4 | 5 | 6 — Members: - `0` — Kavita - `1` — AniList - `2` — Mal - `4` — Cbr - `5` — Hardcover - `6` — MangaBaka
    - `sourceUrl` string, nullable
    - `totalSourceCount` integer
    - `missingSeriesFromSource` string, nullable
  - `readingLists` ReadingListDto[], nullable
    - `id` integer
    - `title` string, nullable
    - `summary` string, nullable
    - `promoted` boolean
    - `coverImageLocked` boolean
    - `coverImage` string, nullable
    - `primaryColor` string, nullable
    - `secondaryColor` string, nullable
    - `itemCount` integer
    - `startingYear` integer
    - `startingMonth` integer
    - `endingYear` integer
    - `endingMonth` integer
    - `ageRating` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | -1, required — Members: - `0` — Unknown - `1` — Rating Pending (RatingPending) - `2` — Early Childhood (EarlyChildhood) - `3` — Everyone - `4` — G - `5` — Everyone 10+ (Everyone10Plus) - `6` — PG - `7` — Kids to Adults (KidsToAdults) - `8` — Teen - `9` — MA15+ (Mature15Plus) - `10` — Mature 17+ (Mature17Plus) - `11` — M (Mature) - `12` — R18+ (R18Plus) - `13` — Adults Only 18+ (AdultsOnly) - `14` — X18+ (X18Plus) - `-1` — Not Applicable (NotApplicable)
    - `ownerUserName` string, nullable
    - `sourcePath` string, nullable
    - `downloadUrl` string, nullable
    - `shaHash` string, nullable
    - `provider` 0 | 1 | 2 — Members: - `0` — File (None) - `1` — File - `2` — Url
    - `lastSyncCheckUtc` string, date-time, nullable
    - `lastSyncedUtc` string, date-time, nullable
    - `totalItemsAtImport` integer
    - `tags` ReadingListTagDto[], nullable
      - `id` integer
      - `title` string, nullable, required
      - `normalizedTitle` string, nullable, required
    - `canSync` boolean
  - `persons` PersonDto[], nullable
    - `id` integer
    - `name` string, nullable, required
    - `coverImageLocked` boolean
    - `primaryColor` string, nullable
    - `secondaryColor` string, nullable
    - `coverImage` string, nullable
    - `aliases` string[], nullable
    - `description` string, nullable
    - `asin` string, nullable
    - `aniListId` integer
    - `malId` integer
    - `hardcoverId` string, nullable
    - `webLinks` string[], nullable
    - `roles` PersonRole[], nullable
  - `genres` GenreTagDto[], nullable
    - `id` integer
    - `title` string, nullable, required
  - `tags` TagDto[], nullable
    - `id` integer
    - `title` string, nullable, required
  - `files` MangaFileDto[], nullable
    - `id` integer
    - `filePath` string, nullable
    - `pages` integer
    - `bytes` integer
    - `format` 0 | 1 | 2 | 3 | 4 — Members: - `0` — Image - `1` — Archive - `2` — Unknown - `3` — EPUB (Epub) - `4` — PDF (Pdf)
    - `created` string, date-time
    - `extension` string, nullable
    - `koreaderHash` string, nullable
  - `chapters` ChapterDto[], nullable
    - `id` integer
    - `range` string, nullable
    - `number` string, nullable
    - `minNumber` number, float
    - `maxNumber` number, float
    - `sortOrder` number, float
    - `pages` integer
    - `isSpecial` boolean
    - `title` string, nullable
    - `files` MangaFileDto[], nullable
      - `id` integer
      - `filePath` string, nullable
      - `pages` integer
      - `bytes` integer
      - `format` 0 | 1 | 2 | 3 | 4 — Members: - `0` — Image - `1` — Archive - `2` — Unknown - `3` — EPUB (Epub) - `4` — PDF (Pdf)
      - `created` string, date-time
      - `extension` string, nullable
      - `koreaderHash` string, nullable
    - `pagesRead` integer
    - `totalReads` integer
    - `lastReadingProgressUtc` string, date-time
    - `lastReadingProgress` string, date-time
    - `coverImageLocked` boolean
    - `volumeId` integer
    - `createdUtc` string, date-time
    - `lastModifiedUtc` string, date-time
    - `created` string, date-time
    - `releaseDate` string, date-time
    - `titleName` string, nullable
    - `summary` string, nullable
    - `ageRating` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | -1 — Members: - `0` — Unknown - `1` — Rating Pending (RatingPending) - `2` — Early Childhood (EarlyChildhood) - `3` — Everyone - `4` — G - `5` — Everyone 10+ (Everyone10Plus) - `6` — PG - `7` — Kids to Adults (KidsToAdults) - `8` — Teen - `9` — MA15+ (Mature15Plus) - `10` — Mature 17+ (Mature17Plus) - `11` — M (Mature) - `12` — R18+ (R18Plus) - `13` — Adults Only 18+ (AdultsOnly) - `14` — X18+ (X18Plus) - `-1` — Not Applicable (NotApplicable)
    - `wordCount` integer
    - `volumeTitle` string, nullable
    - `minHoursToRead` integer
    - `maxHoursToRead` integer
    - `avgHoursToRead` number, float
    - `webLinks` string, nullable
    - `isbn` string, nullable
    - `writers` PersonDto[], nullable
      - `id` integer
      - `name` string, nullable, required
      - `coverImageLocked` boolean
      - `primaryColor` string, nullable
      - `secondaryColor` string, nullable
      - `coverImage` string, nullable
      - `aliases` string[], nullable
      - `description` string, nullable
      - `asin` string, nullable
      - `aniListId` integer
      - `malId` integer
      - `hardcoverId` string, nullable
      - `webLinks` string[], nullable
      - `roles` PersonRole[], nullable
    - `coverArtists` PersonDto[], nullable
      - `id` integer
      - `name` string, nullable, required
      - `coverImageLocked` boolean
      - `primaryColor` string, nullable
      - `secondaryColor` string, nullable
      - `coverImage` string, nullable
      - `aliases` string[], nullable
      - `description` string, nullable
      - `asin` string, nullable
      - `aniListId` integer
      - `malId` integer
      - `hardcoverId` string, nullable
      - `webLinks` string[], nullable
      - `roles` PersonRole[], nullable
    - `publishers` PersonDto[], nullable
      - `id` integer
      - `name` string, nullable, required
      - `coverImageLocked` boolean
      - `primaryColor` string, nullable
      - `secondaryColor` string, nullable
      - `coverImage` string, nullable
      - `aliases` string[], nullable
      - `description` string, nullable
      - `asin` string, nullable
      - `aniListId` integer
      - `malId` integer
      - `hardcoverId` string, nullable
      - `webLinks` string[], nullable
      - `roles` PersonRole[], nullable
    - `characters` PersonDto[], nullable
      - `id` integer
      - `name` string, nullable, required
      - `coverImageLocked` boolean
      - `primaryColor` string, nullable
      - `secondaryColor` string, nullable
      - `coverImage` string, nullable
      - `aliases` string[], nullable
      - `description` string, nullable
      - `asin` string, nullable
      - `aniListId` integer
      - `malId` integer
      - `hardcoverId` string, nullable
      - `webLinks` string[], nullable
      - `roles` PersonRole[], nullable
    - `pencillers` PersonDto[], nullable
      - `id` integer
      - `name` string, nullable, required
      - `coverImageLocked` boolean
      - `primaryColor` string, nullable
      - `secondaryColor` string, nullable
      - `coverImage` string, nullable
      - `aliases` string[], nullable
      - `description` string, nullable
      - `asin` string, nullable
      - `aniListId` integer
      - `malId` integer
      - `hardcoverId` string, nullable
      - `webLinks` string[], nullable
      - `roles` PersonRole[], nullable
    - `inkers` PersonDto[], nullable
      - `id` integer
      - `name` string, nullable, required
      - `coverImageLocked` boolean
      - `primaryColor` string, nullable
      - `secondaryColor` string, nullable
      - `coverImage` string, nullable
      - `aliases` string[], nullable
      - `description` string, nullable
      - `asin` string, nullable
      - `aniListId` integer
      - `malId` integer
      - `hardcoverId` string, nullable
      - `webLinks` string[], nullable
      - `roles` PersonRole[], nullable
    - `imprints` PersonDto[], nullable
      - `id` integer
      - `name` string, nullable, required
      - `coverImageLocked` boolean
      - `primaryColor` string, nullable
      - `secondaryColor` string, nullable
      - `coverImage` string, nullable
      - `aliases` string[], nullable
      - `description` string, nullable
      - `asin` string, nullable
      - `aniListId` integer
      - `malId` integer
      - `hardcoverId` string, nullable
      - `webLinks` string[], nullable
      - `roles` PersonRole[], nullable
    - `colorists` PersonDto[], nullable
      - `id` integer
      - `name` string, nullable, required
      - `coverImageLocked` boolean
      - `primaryColor` string, nullable
      - `secondaryColor` string, nullable
      - `coverImage` string, nullable
      - `aliases` string[], nullable
      - `description` string, nullable
      - `asin` string, nullable
      - `aniListId` integer
      - `malId` integer
      - `hardcoverId` string, nullable
      - `webLinks` string[], nullable
      - `roles` PersonRole[], nullable
    - `letterers` PersonDto[], nullable
      - `id` integer
      - `name` string, nullable, required
      - `coverImageLocked` boolean
      - `primaryColor` string, nullable
      - `secondaryColor` string, nullable
      - `coverImage` string, nullable
      - `aliases` string[], nullable
      - `description` string, nullable
      - `asin` string, nullable
      - `aniListId` integer
      - `malId` integer
      - `hardcoverId` string, nullable
      - `webLinks` string[], nullable
      - `roles` PersonRole[], nullable
    - `editors` PersonDto[], nullable
      - `id` integer
      - `name` string, nullable, required
      - `coverImageLocked` boolean
      - `primaryColor` string, nullable
      - `secondaryColor` string, nullable
      - `coverImage` string, nullable
      - `aliases` string[], nullable
      - `description` string, nullable
      - `asin` string, nullable
      - `aniListId` integer
      - `malId` integer
      - `hardcoverId` string, nullable
      - `webLinks` string[], nullable
      - `roles` PersonRole[], nullable
    - `translators` PersonDto[], nullable
      - `id` integer
      - `name` string, nullable, required
      - `coverImageLocked` boolean
      - `primaryColor` string, nullable
      - `secondaryColor` string, nullable
      - `coverImage` string, nullable
      - `aliases` string[], nullable
      - `description` string, nullable
      - `asin` string, nullable
      - `aniListId` integer
      - `malId` integer
      - `hardcoverId` string, nullable
      - `webLinks` string[], nullable
      - `roles` PersonRole[], nullable
    - `teams` PersonDto[], nullable
      - `id` integer
      - `name` string, nullable, required
      - `coverImageLocked` boolean
      - `primaryColor` string, nullable
      - `secondaryColor` string, nullable
      - `coverImage` string, nullable
      - `aliases` string[], nullable
      - `description` string, nullable
      - `asin` string, nullable
      - `aniListId` integer
      - `malId` integer
      - `hardcoverId` string, nullable
      - `webLinks` string[], nullable
      - `roles` PersonRole[], nullable
    - `locations` PersonDto[], nullable
      - `id` integer
      - `name` string, nullable, required
      - `coverImageLocked` boolean
      - `primaryColor` string, nullable
      - `secondaryColor` string, nullable
      - `coverImage` string, nullable
      - `aliases` string[], nullable
      - `description` string, nullable
      - `asin` string, nullable
      - `aniListId` integer
      - `malId` integer
      - `hardcoverId` string, nullable
      - `webLinks` string[], nullable
      - `roles` PersonRole[], nullable
    - `genres` GenreTagDto[], nullable
      - `id` integer
      - `title` string, nullable, required
    - `tags` TagDto[], nullable
      - `id` integer
      - `title` string, nullable, required
    - `publicationStatus` 0 | 1 | 2 | 3 | 4 — Members: - `0` — Ongoing (OnGoing) - `1` — Hiatus - `2` — Completed - `3` — Cancelled - `4` — Ended
    - `language` string, nullable
    - `count` integer
    - `totalCount` integer
    - `languageLocked` boolean
    - `summaryLocked` boolean
    - `ageRatingLocked` boolean
    - `publicationStatusLocked` boolean
    - `genresLocked` boolean
    - `tagsLocked` boolean
    - `writerLocked` boolean
    - `characterLocked` boolean
    - `coloristLocked` boolean
    - `editorLocked` boolean
    - `inkerLocked` boolean
    - `imprintLocked` boolean
    - `lettererLocked` boolean
    - `pencillerLocked` boolean
    - `publisherLocked` boolean
    - `translatorLocked` boolean
    - `teamLocked` boolean
    - `locationLocked` boolean
    - `coverArtistLocked` boolean
    - `releaseDateLocked` boolean
    - `titleNameLocked` boolean
    - `sortOrderLocked` boolean
    - `coverImage` string, nullable
    - `primaryColor` string, nullable
    - `secondaryColor` string, nullable
    - `format` 0 | 1 | 2 | 3 | 4 — Members: - `0` — Image - `1` — Archive - `2` — Unknown - `3` — EPUB (Epub) - `4` — PDF (Pdf)
    - `aniListId` integer
    - `malId` integer
    - `hardcoverId` integer
    - `metronId` integer
    - `comicVineId` string, nullable
    - `mangaBakaId` integer
    - `cbrId` integer
  - `bookmarks` BookmarkSearchResultDto[], nullable
    - `libraryId` integer
    - `volumeId` integer
    - `seriesId` integer
    - `chapterId` integer
    - `seriesName` string, nullable
    - `localizedSeriesName` string, nullable
  - `annotations` AnnotationDto[], nullable
    - `id` integer
    - `xPath` string, nullable, required
    - `endingXPath` string, nullable
    - `selectedText` string, nullable
    - `comment` string, nullable
    - `commentHtml` string, nullable
    - `commentPlainText` string, nullable
    - `chapterTitle` string, nullable
    - `context` string, nullable
    - `highlightCount` integer
    - `containsSpoiler` boolean
    - `pageNumber` integer
    - `selectedSlotIndex` integer
    - `likes` integer[], nullable
    - `seriesName` string, nullable
    - `libraryName` string, nullable
    - `chapterId` integer, required
    - `volumeId` integer, required
    - `seriesId` integer, required
    - `libraryId` integer, required
    - `ownerUserId` integer, required
    - `ownerUsername` string, nullable
    - `ageRating` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | -1 — Members: - `0` — Unknown - `1` — Rating Pending (RatingPending) - `2` — Early Childhood (EarlyChildhood) - `3` — Everyone - `4` — G - `5` — Everyone 10+ (Everyone10Plus) - `6` — PG - `7` — Kids to Adults (KidsToAdults) - `8` — Teen - `9` — MA15+ (Mature15Plus) - `10` — Mature 17+ (Mature17Plus) - `11` — M (Mature) - `12` — R18+ (R18Plus) - `13` — Adults Only 18+ (AdultsOnly) - `14` — X18+ (X18Plus) - `-1` — Not Applicable (NotApplicable)
    - `createdUtc` string, date-time
    - `lastModifiedUtc` string, date-time

---

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