Sign in

v1

latestOpenAPI 3.1.02026-07-223261135.0 KB
canvases

Get Canvas

Get the semantic design spec + structured canvas metadata.

get/canvases/{canvas_id}

Path parameters

canvas_idstring required

Prefixed cvs_ wire ID (Crockford base32 body) — the canonical, recommended form. For back-compat, a bare UUID string is also accepted in both path parameters and JSON request bodies (older integrations that stored raw UUIDs keep working). Both are permanent, supported inputs.

Example:cvs_01HT9WK8N3M2J4A5Z6P7Q8R9TV

Query parameters

page_numberinteger nullable

1-indexed page number

1-indexed page number

share_tokenstring nullable

Optional share token from POST /v1/share_links/resolve. When set, the canvas is fetched via the public share endpoint instead of DB auth, allowing callers who aren't on the canvas's team to read shared designs.

Optional share token from POST /v1/share_links/resolve. When set, the canvas is fetched via the public share endpoint instead of DB auth, allowing callers who aren't on the canvas's team to read shared designs.

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

canvas_idstring required

Prefixed canvas identifier for the requested canvas.

canvas_urlstring required

Full URL to open this canvas in the Moda editor.

designstring required

Semantic pseudo-HTML design spec for the canvas (or the requested page).

namestring nullable

Canvas display name.

descriptionstring nullable

Canvas description, or null.

template_typestring nullable

'template', 'theme', or null.

Example response

{
  "canvas_id": "cvs_01HT9WK8N3M2J4A5Z6P7Q8R9TV"
}