MOmoda
canvas-actions

Read Canvas State

Changed on

The authoring read: lossless DSL snapshot + short-id table + revision token.

Distinct from GET /v1/canvases/{id} (the design-to-code semantic read) — this is the byte-identical agent snapshot the mutation verbs address.

get/canvases/{canvas_ref}/state

Request

  • Base URL
    https://api.moda.app/v1
  • URL
    https://api.moda.app/v1/canvases/{canvas_ref}/state
  • Auth
    HTTP bearer

Path parameters

canvas_refstring required

Query parameters

page_idstring nullable

Restrict to one page (short p-ref or real id).

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

object required

Changes