Skip to main content
GET
Get Canvas

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"

Path Parameters

canvas_id
string
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.

Pattern: ^cvs_[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
Example:

"cvs_01HT9WK8N3M2J4A5Z6P7Q8R9TV"

Query Parameters

page_number
integer | null

1-indexed page number

share_token
string | null

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.

Response

Successful Response

Response shape for GET /v1/canvases/{id}.

Carries the semantic design markdown plus structured handles back to the source canvas so callers don't have to parse the # Source: header out of the markdown body to link back to the editor.

canvas_id
string
required

Prefixed canvas identifier for the requested canvas.

Pattern: ^cvs_[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
Example:

"cvs_01HT9WK8N3M2J4A5Z6P7Q8R9TV"

canvas_url
string
required

Full URL to open this canvas in the Moda editor.

design
string
required

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

name
string | null

Canvas display name.

description
string | null

Canvas description, or null.

template_type
string | null

'template', 'theme', or null.