Search Canvases
Search canvases by name or content (relevance-ranked, offset-paginated).
A search lane has no cheap true total, so the response carries an explicit
has_more instead — when true, request the next page with
offset = offset + limit. Results are capped at limit per page
(default 20, cap 100).
Authorizations
API key from Settings > Developer > REST API
Headers
Calendar-dated API version pin. New integrations should pin 2026-05-01 to opt into the newest response shapes. For back-compat the server also accepts requests with no header and resolves them to the current default (today: 2026-04-12); that default advances on each sunset date. Any unsupported value returns 400 unsupported_version.
2026-04-12, 2026-05-01 "2026-05-01"
Query Parameters
Search query
Max results per page. Defaults to 20, caps at 100.
1 <= x <= 100Results to skip — pass offset + limit to page through.
x >= 0Response
Successful Response
Relevance-ranked canvas search response.
A search lane has no cheap true total (ranking + full-text matching make
COUNT(*) as expensive as the search itself), so total is omitted;
has_more is always present and explicit — a page is never allowed to
silently look complete. Page through with offset.
Canvases matching the search query, ranked by relevance.
Number of canvases in this page (always len(canvases)).
The effective page-size limit this response was computed with.
Offset this page started at. Pass offset + limit to continue.
true when more matches exist beyond this page — request the next page via offset.