Skip to main content
GET
/
canvases
/
{canvas_id}
/
pages
List Canvas Pages
curl --request GET \
  --url https://api.moda.app/v1/canvases/{canvas_id}/pages \
  --header 'Authorization: Bearer <token>'
{
  "canvas_name": "<string>",
  "pages": [
    {}
  ],
  "total_pages": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.moda.app/llms.txt

Use this file to discover all available pages before exploring further.

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). Path parameters additionally accept a bare UUID string for back-compat; JSON body fields require the prefixed form.

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

"cvs_01HT9WK8N3M2J4A5Z6P7Q8R9TV"

Query Parameters

​
share_token
string | null

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

Response

Successful Response

​
canvas_name
string
required

Display name of the canvas.

​
pages
Pages · object[]
required

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

​
total_pages
integer
required

Total number of pages in the canvas.