---
title: "Search"
method: GET
path: "/search"
---

# Search

`GET /search`

Search across all entity types within the authenticated organization.

Applies ilike substring matching on name fields and Postgres prefix
tsquery (``to_tsquery`` with ``:*``) FTS on free-form text fields (description, notes).

Parameters
----------
q : str
    Search query, minimum 2 characters.
limit : int
    Maximum number of results to return in this page (1–100).
offset : int
    Number of results to skip before this page.
per_type : int
    Maximum results to return per entity type (1–20). Defaults to 5.
entity_types : list[str] | None
    When provided, restrict results to these entity type strings.
    Omit to search all types.
project_id : str | None
    When set, scope project-scoped entities (pipelines, optimizations, studies)
    to this project. Org-scoped entities are unaffected.

Returns
-------
SearchResponse
    Paginated results from matching entity types with ``total`` count.

## Query parameters

- `q` string, required — Search query (minimum 2 characters)
- `limit` integer — Maximum results to return in this page
- `offset` integer — Number of results to skip before this page
- `per_type` integer — Maximum results to return per entity type (1–20).
- `entity_types` string[], nullable — Restrict to these entity type strings (repeatable). Omit to search all types.
- `project_id` string, nullable — When set, scope project-scoped entities to this project.

## Response `200`

Successful Response

- SearchResponse — Response from the global search endpoint.
  - `results` SearchResult[], required
    - `id` string, required
    - `entity_type` string, required
    - `name` string, required
    - `project_id` string, nullable
    - `created_at` string, nullable
    - `parent_id` string, nullable
  - `query` string, required
  - `total` integer, required
  - `limit` integer, required
  - `offset` integer, required

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.dev/ionworks/apis/fastapi.md) · [All operations](https://skmtc.dev/ionworks/apis/fastapi/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/ionworks/fastapi/revisions/7337a3cbdaf2/schema)