---
title: "Find boards and cards by text"
method: GET
path: "/search"
---

# Find boards and cards by text

`GET /search`

## Request

- Base URL: `https://clusters.soleilpictures.com/api/v1`
- URL: `https://clusters.soleilpictures.com/api/v1/search`
- Auth: HTTP bearer

Searches board names, and card titles and bodies. This is how to find the board about something without listing every board and reading each one.

## Query parameters

- `q` string, required
- `kind` 'board' | 'card'
- `workspace` string, uuid
- `limit` integer
- `offset` integer

## Response `200`

Matching boards and cards. Card hits carry a 300-character excerpt, not the whole card.

- object
  - `query` string
  - `boards` object
    - `items` object[]
      - `id` string, uuid
      - `name` string
      - `workspace_id` string, uuid
      - `parent_board_id` string, uuid, nullable
      - `view` 'canvas' | 'list'
      - `deleted` boolean
      - `created_at` string, date-time
      - `updated_at` string, date-time, nullable
      - `scheduled_date` string, date, nullable: The calendar date this board sits on, if any.
      - `scheduled_end` string, date, nullable: Inclusive end of a multi-day block. Null for a single day.
      - `day_label` string, nullable: The durable half of a scheduled day's name, e.g. "Day 12". The date is never stored in the name.
      - `sched_status` 'draft' | 'published' | 'cancelled'
      - `sched_version` integer: Bumped on publish. Only a published board notifies its readers when it moves.
      - `sched_published_at` string, date-time, nullable
    - `limit` integer
    - `offset` integer
    - `has_more` boolean
    - `next_offset` integer, nullable
  - `cards` object
    - `items` unknown[]
      - unknown
    - `limit` integer
    - `offset` integer
    - `has_more` boolean
    - `next_offset` integer, nullable

## Other responses

- `400`: q was shorter than 2 characters, or a filter was not a uuid

---

[API](https://skmtc.dev/soleilpictures/apis/soleil-clusters-api.md) · [All operations](https://skmtc.dev/soleilpictures/apis/soleil-clusters-api/llms.txt) · [OpenAPI document](https://skmtc.dev/soleilpictures/apis/soleil-clusters-api/revisions/1d426d587bf3?raw)