---
title: "Search Feature Readiness items"
method: GET
path: "/app/{appId}/release/{releaseId}/featureReadiness/search"
tags: ["release"]
---

# Search Feature Readiness items

`GET /app/{appId}/release/{releaseId}/featureReadiness/search`

## Request

- Base URL: `https://api.runway.team`
- URL: `https://api.runway.team/app/{appId}/release/{releaseId}/featureReadiness/search`
- Auth: API key in header `X-API-Key`

Search the Feature Readiness work items on a release by keyword. Returns only items whose ticket identifier, ticket description, PR/commit title or message, author, or branch name contain the query string (case-insensitive). Returns an empty array when nothing matches. Use this instead of fetching the full `featureReadiness` step when you need to find items matching a specific ticket, author, or keyword.

## Path parameters

- `appId` string, required
- `releaseId` string, required

## Query parameters

- `query` string, required

## Response `200`

Paginated search results for Feature Readiness items

- object
  - `items` FeatureReadinessItemEntity[], required
    - `id` string: The unique identifier for the item. Pass this value as `frItemId` when calling the ignore/un-ignore endpoint.
    - `ticket` object, nullable: The ticket associated with this item, if any.
      - `identifier` string
      - `description` string
      - `url` string
      - `owner` string, nullable
      - `reporter` string, nullable
      - `status` string
      - `isTicketDone` boolean
      - `priority` string, nullable
      - `ticketType` string, nullable
    - `code` union: The code associated with this item: either a pull request (PR / code review) or a commit (or null if none). This is the canonical location of pull request / code review information on a release — query the `featureReadiness` step to retrieve PR data.
      - WorkItemCodePullRequest
        - `identifier` string, required: The identifier of the pull request
        - `codeStatus` 'openPR' | 'merged' | 'unmerged' | 'cherryPickPending' | 'cherryPickOpen' | 'cherryPickFailed' | 'cherryPickMerged': Status of WorkItemCode entity
        - `type` 'commit' | 'pullRequest', required: Type of WorkItemCode entity
        - `url` string, required: The url of the pull request
        - `title` string, required: The title of the pull request
        - `description` string, required: The description of the pull request
        - `baseBranch` string, required: The base branch of the pull request
        - `headBranch` string, required: The head branch of the pull request
        - `author` string, required: The author of the pull request
        - `createdAt` string, date-time, required: The date and time the pull request was created
        - `updatedAt` string, date-time, required: The date and time the pull request was last updated
        - `pullRequestStatus` 'open' | 'merged' | 'closed' | 'unknown', required: Status of WorkItemCode entity
      - WorkItemCodeCommit
        - `identifier` string, required: The identifier of the commit
        - `codeStatus` 'openPR' | 'merged' | 'unmerged' | 'cherryPickPending' | 'cherryPickOpen' | 'cherryPickFailed' | 'cherryPickMerged', required: Status of WorkItemCode entity
        - `type` 'commit' | 'pullRequest', required: Type of WorkItemCode entity
        - `url` string, required: The url of the commit
        - `author` string, required: The author of the commit
        - `message` string, required: The message of the commit
        - `branch` string, required: The branch of the commit
        - `committedAt` string, date-time, required: The date and time the commit was created
        - `authoredAt` string, date-time, required: The date and time the commit was authored
    - `explanationText` string, nullable: Optional explanation for the item.
    - `ignored` boolean: Whether the item has been ignored. Ignored items no longer block the release from being considered ready.
    - `autoIgnored` boolean: Whether the item would be ignored automatically based on app settings.
    - `isItemDone` boolean: True when both the code is merged and the ticket is done.
    - `debugVariant` string: Identifies which variation of feature item this is (used to indicate the source of the work item).
  - `hasMore` boolean, required: Whether more results exist beyond the current page
  - `total` integer, required: Total number of matching items across all pages

## Other responses

- `400`: Bad request response
- `404`: Resource not found response

---

[API](https://skmtc.dev/runway/apis/runway-rest-api.md) - [All operations](https://skmtc.dev/runway/apis/runway-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/runway/apis/runway-rest-api/revisions/081109863a9a?raw)