canvases

Search Canvases

Changed on

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).

get/canvases/search

Request

  • Base URL
    https://api.moda.app/v1
  • URL
    https://api.moda.app/v1/canvases/search
  • Auth
    HTTP bearer

Query parameters

qstring required

Search query

limitinteger

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

offsetinteger

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

Headers

Moda-Version'2026-04-12' | '2026-05-01'
Example: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.

Response

Successful Response

returnedinteger

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

limitinteger

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

offsetinteger

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

has_moreboolean

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

Example response

{
  "canvases": [
    {
      "id": "cvs_01HT9WK8N3M2J4A5Z6P7Q8R9TV"
    }
  ]
}

Changes

    • info

      added the new optional query request parameter offset

    • info

      added the non-success response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status