Skip to main content
GET
Search Canvases

Authorizations

Authorization
string
header
required

API key from Settings > Developer > REST API

Headers

Moda-Version
enum<string>
default:2026-05-01

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.

Available options:
2026-04-12,
2026-05-01
Example:

"2026-05-01"

Query Parameters

q
string
required

Search query

limit
integer
default:20

Max results per page. Defaults to 20, caps at 100.

Required range: 1 <= x <= 100
offset
integer
default:0

Results to skip — pass offset + limit to page through.

Required range: x >= 0

Response

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
CanvasItem · object[]
required

Canvases matching the search query, ranked by relevance.

returned
integer
default:0

Number of canvases in this page (always len(canvases)).

limit
integer
default:20

The effective page-size limit this response was computed with.

offset
integer
default:0

Offset this page started at. Pass offset + limit to continue.

has_more
boolean
default:false

true when more matches exist beyond this page — request the next page via offset.