---
title: "Read Canvas State Summary"
method: GET
path: "/canvases/{canvas_ref}/state/summary"
tags: ["canvas-actions"]
---

# Read Canvas State Summary

`GET /canvases/{canvas_ref}/state/summary`

## Request

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

Structural summary of the canvas: page index + node counts, no DSL payload.

The cheap-to-consume sibling of ``GET .../state`` (whose DSL can run to
hundreds of KB on big canvases). Computed from the SAME projection as the
full read — same optimizer chain, same per-page node reachability counts —
and it counts as a read for revision-pin purposes: ``revision`` is the same
read-lane token the full read returns, safe to pin as ``expected_revision``.
Page ids are the same session-scoped ``p_*`` short refs the full read mints
(the mapping table is persisted), so they round-trip into the write verbs.

## Path parameters

- `canvas_ref` string, required

## Headers

- `Moda-Version` '2026-04-12' | '2026-05-01'

## Response `200`

Successful Response

- object

## Other responses

- `401`: Authentication required.
- `402`: Insufficient credits for a metered operation.
- `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.

## Changes

- **2026-11-03** `9ac6a3abc0f8`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/moda/apis/moda-public-api/changes/canvases/:canvas_ref/state/summary/get.md)

---

[API](https://skmtc.dev/moda/apis/moda-public-api.md) - [All operations](https://skmtc.dev/moda/apis/moda-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/moda/apis/moda-public-api/revisions/9ac6a3abc0f8?raw)