Sign in

v1

latestOpenAPI 3.1.02026-08-063512102.9 KB

Search workspace

Search for canvases in the workspace by title or content.

get/v1/workspaces/search

Query parameters

querystring required

The search query to match against canvas content (must be non-empty)

fromstring

The offset to start from (for pagination)

sizestring

The maximum number of results to return

'created_at'

When the canvas was created

OR
'modified_at'

When the canvas was modified

OR
'relevance'

How relevant the search result is

The field to sort by

'asc'

Order results in ascending order

OR
'desc'

Order results in descending order

project_keysstring

Filter results to only these projects. Multiple projects should be represented as a comma-separated list

'true'

True

OR
'false'

False

Only search in canvas titles

created_bystring

Filter results to canvases created by these users. Multiple users should be represented as a comma-separated list

Response

Successful response

successtrue required
request_idstring required