---
title: "Search workspace"
method: GET
path: "/v1/workspaces/search"
---

# Search workspace

`GET /v1/workspaces/search`

Search for canvases in the workspace by title or content.

## Query parameters

- `query` string, required
- `from` string
- `size` string
- `sort_by` union
  - 'created_at' — When the canvas was created
  - 'modified_at' — When the canvas was modified
  - 'relevance' — How relevant the search result is
- `sort_direction` union
  - 'asc' — Order results in ascending order
  - 'desc' — Order results in descending order
- `project_keys` string
- `title_only` union
  - 'true' — True
  - 'false' — False
- `created_by` string

## Response `200`

Successful response

- object — Base response envelope for all successful API responses.
  - `success` true, required
  - `request_id` string, required
  - `result` object, required
    - `results` object[], required — The search results
      - `key` string, required — The unique identifier for the canvas
      - `name` string, required — The display name for the canvas
      - `project_key` string, required — The unique identifier for the project
      - `project_name` string, required — The display name for the project
      - `created_at` string, date-time, required — An ISO 8601 date-time string.
      - `created_by` string, required — The unique identifier for the user
      - `modified_at` string, date-time, required — An ISO 8601 date-time string.
      - `modified_by` string, nullable, required — The unique identifier for the user
      - `preview` string, nullable, required — The preview URL
      - `object_results` object[], required — The list of search results within objects in this canvas
        - `key` string, required — The unique identifier for an object in a canvas
        - `name` string, required — The name of the object
        - `text` string, required — The text contents of the object
        - `type` union, required — The type of object
          - 'cell' — Cell
          - 'ellipse' — Ellipse
          - 'rectangle' — Rectangle
          - 'sticky_note' — Sticky note
          - 'text' — Text
          - 'thread' — Comment thread
          - 'overview' — Overview
    - `more_results` boolean, required — Whether there are more results available

## Other responses

- `4XX` — Client error. Possible status codes include: 400 (invalid request), 401 (missing or invalid API key), 403 (insufficient permissions), 404 (resource not found), 429 (rate limit exceeded).
- `5XX` — Internal server error.

---

[API](https://skmtc.dev/count/apis/count-public-api.md) · [All operations](https://skmtc.dev/count/apis/count-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/count/count-public-api/revisions/8bfa1b92c91d/schema)