Search workspace
GET/v1/workspaces/search
Search for canvases in the workspace by title or content.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| queryrequired | query | string | The search query to match against canvas content (must be non-empty) |
| from | query | string | The offset to start from (for pagination) |
| size | query | string | The maximum number of results to return |
| sort_by | query | "created_at" | "modified_at" | "relevance" | The field to sort by |
| sort_direction | query | "asc" | "desc" | |
| project_keys | query | string | Filter results to only these projects. Multiple projects should be represented as a comma-separated list |
| title_only | query | "true" | "false" | Only search in canvas titles |
| created_by | query | string | Filter results to canvases created by these users. Multiple users should be represented as a comma-separated list |
Responses
Successful response
success * boolean
request_id * string
result * object
results * object[] — The search results
key * string — The unique identifier for the canvas
name * string — The display name for the canvas
project_key * string — The unique identifier for the project
project_name * string — The display name for the project
created_at * string (date-time) — An ISO 8601 date-time string.
created_by * string — The unique identifier for the user
modified_at * string (date-time) | null — An ISO 8601 date-time string, or null.
modified_by * string | null — Who last modified the canvas
preview * string | null — A preview image URL for the canvas
object_results * object[] — The list of search results within objects in this canvas
key * string — The unique identifier for an object in a canvas
name * string — The name of the object
text * string — The text contents of the object
type * "cell" | "ellipse" | "rectangle" | "sticky_note" | "text" | "thread" | "overview" — The type of object
more_results * boolean — Whether there are more results available