MOmoda
canvases

Get Canvas

Changed on

Get the semantic design spec + structured canvas metadata.

get/canvases/{canvas_id}

Request

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

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), as is the prefix over a UUID body (cvs_00000000-0000-4000-8000-000000000000). All three are permanent, supported inputs; only the canonical form is ever emitted.

Example:cvs_01HT9WK8N3M2J4A5Z6P7Q8R9TV

Query parameters

page_numberinteger nullable

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.

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"
}

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