---
title: "Get Canvas"
method: GET
path: "/canvases/{canvas_id}"
tags: ["canvases"]
---

# Get Canvas

`GET /canvases/{canvas_id}`

Get the semantic design spec + structured canvas metadata.

## 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.

## Query parameters

- `page_number` integer, nullable — 1-indexed page number
- `share_token` string, 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'

## Response `200`

Successful Response

- GetCanvasResponse — 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.
  - `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, nullable — Canvas display name.
  - `description` string, nullable — Canvas description, or null.
  - `template_type` string, nullable — 'template', 'theme', or null.

## Other responses

- `401` — Authentication required.
- `403` — Permission denied for this scope.
- `404` — Resource not found.
- `409` — Conflict (idempotency / resource state).
- `422` — Request validation failed.
- `429` — Rate limit exceeded.
- `500` — Internal error.

---

[API](https://skmtc.net/moda/apis/moda-public-api.md) · [All operations](https://skmtc.net/moda/apis/moda-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/moda/moda-public-api/versions/b34cb4cca59e/schema)