v1

latestOpenAPI 3.1.02026-07-223261135.0 KB

canvases

List Canvas Pages

List pages in a canvas with dimensions and node counts.

get/canvases/{canvas_id}/pages

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

share_tokenstring nullable

Optional share token (see GET /canvases/{canvas_id}).

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_namestring required

Display name of the canvas.

pagesobject[] required

List of page objects with name, dimensions, and element counts.

total_pagesinteger required

Total number of pages in the canvas.