---
title: "Search quality patches for a version"
method: GET
path: "/api/v1/patches/search"
tags: ["patches"]
---

# Search quality patches for a version

`GET /api/v1/patches/search`

## Request

- Base URL: `https://magento.watch`
- URL: `https://magento.watch/api/v1/patches/search`
- Auth: none required

## Query parameters

- `distribution` 'magento-community' | 'magento-commerce' | 'mage-os', required
- `version` string, required
- `query` string
- `modules` string[]
- `categories` string[]
- `includeInapplicable` boolean
- `limit` integer

## Response `200`

Search quality patches for a version

- PatchSearchResponse
  - `data` FindPatchResult, required
    - `status` 'ok' | 'unknown' | 'unknown-version', required
    - `mode` 'list' | 'ranked', required
    - `distribution` string, required
    - `version` string, required
    - `hits` PatchHit[], required
      - `id` string, required
      - `score` integer
      - `install` object
        - `qpt` object, required
          - `command` string, required
          - `cloud` string, required
          - `requires` string[], required
        - `composer` object, nullable, required
          - `zipUrl` string, uri, required
          - `packages` string[], required
          - `hasTests` boolean, required
      - `applicable` boolean, required
      - `deprecated` boolean, required
      - `title` string, required
      - `categories` string[], required
      - `components` string[], required
      - `documentationUrl` string, nullable, required
      - `files` PatchHitFile[], required
        - `package` string, required
        - `constraint` string, required
        - `url` string, uri, required
        - `modifies` string[], required
        - `modifiesTruncated` boolean, required
        - `requires` string[], required
        - `replacedWith` string, nullable, required
        - `deprecated` boolean, required
      - `requirements` string, nullable, required
      - `matchedOn` string[], required
    - `knownVersions` string[]
    - `coverage` object, required
      - `qptTag` string, required
      - `docsCommit` string, required
      - `patchCount` integer, required
  - `_documentation` string, uri, required
  - `_description` string, required

## Other responses

- `400`: Invalid search input

---

[API](https://skmtc.dev/magento/apis/magento-watch-api.md) · [All operations](https://skmtc.dev/magento/apis/magento-watch-api/llms.txt) · [OpenAPI document](https://skmtc.dev/magento/apis/magento-watch-api/revisions/e542302fb8a0?raw)