MOmoda
canvases

List Canvases

Changed on

List canvases accessible to the API key's team (cursor pagination).

Returns at most limit canvases per page (default 20, cap 100). No cheap true total exists on this lane (the doc-kind filter reads un-indexed JSONB, so an exact count would scan every canvas document) — has_more is always explicit instead: iterate next_cursor while it is true to fetch everything.

get/canvases

Request

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

Query parameters

cursorstring nullable

Opaque pagination cursor. Pass the next_cursor from the previous response. Omit on the first request.

limitinteger

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

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

next_cursorstring nullable

Opaque cursor to pass as ?cursor= on the next request. null means you've reached the end of the collection.

returnedinteger

Number of items in this page (always len(data); derived server-side).

has_moreboolean

true when more items exist beyond this page — keep requesting with next_cursor until this is false. Never trust len(data) < limit alone.

limitinteger nullable

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

totalinteger nullable

True total number of items in the collection (after filters), when the endpoint can count cheaply. null on log/search lanes — use has_more there.

Example response

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

Changes

  • 9ac6a3abc0f8Revision changes
    • 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