---
title: "Search screens"
method: GET
path: "/api/v1/screens"
tags: ["screens"]
---

# Search screens

`GET /api/v1/screens`

## Request

- Base URL: `https://screenrove.com`
- URL: `https://screenrove.com/api/v1/screens`
- Auth: none declared

Search the UI reference catalog by keyword across titles, notes, page sections, and observed
actions. Filter by product or kind (flow/marketing/product).

Use this to find design pattern examples like "pricing page", "empty state", "date picker",
"onboarding step", "checkout form", "dashboard", "sign-up", "settings", etc. Returns the
best matches with screen IDs you can pass to getScreen or getScreenImage.

## Query parameters

- `q` string
- `product` string
- `kind` 'flow' | 'marketing' | 'product': flow is an onboarding step, marketing a public web page, product an in-app screen.
- `limit` integer

## Response `200`

Matching screens, best match first.

- object
  - `total` integer
  - `screens` ScreenSummary[]
    - `id` string
    - `product` string
    - `kind` 'flow' | 'marketing' | 'product': flow is an onboarding step, marketing a public web page, product an in-app screen.
    - `title` string
    - `notes` string
    - `imageUrl` string
    - `previewUrl` string: Screen-sized preview (the top of long pages). Present on pick options.
    - `productName` string: Present on pick options.

---

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