---
title: "Search the workspace"
method: GET
path: "/v1/search"
tags: ["search"]
---

# Search the workspace

`GET /v1/search`

## Request

- Base URL: `https://api.flowral.app`
- URL: `https://api.flowral.app/v1/search`
- Auth: one of:
  - HTTP bearer
  - OAuth 2 (client credentials, token URL `https://api.flowral.app/v1/oauth/token`, scopes: `flows:read`)

Flows, tasks and templates matching a query — for a picker, or to resolve a name a human typed into an id.

## Query parameters

- `q` string, required
- `type` string: `flow`, `task` or `template`. Omit for all three.
- `size` integer

## Response `200`

SUCCESS

- object
  - `total` integer, required: Total matching, not the length of `items`.
  - `items` SearchResult[], required
    - `id` string, required
    - `type` 'flow' | 'task' | 'template', required
    - `title` string, required
    - `flowId` string, nullable
    - `url` string: Where it lives in the app, for a link back.

## Other responses

- `400`: VALIDATION_FAILED
- `401`: UNAUTHORIZED
- `403`: FORBIDDEN · PLAN_REQUIRED · INSUFFICIENT_SCOPE
- `429`: RATE_LIMITED

---

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