Layovelle

List Canvas Pages

Documentation

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>'
import requests

url = "https://api.moda.app/v1/canvases/{canvas_id}/pages"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.moda.app/v1/canvases/{canvas_id}/pages', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.moda.app/v1/canvases/{canvas_id}/pages",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.moda.app/v1/canvases/{canvas_id}/pages"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.moda.app/v1/canvases/{canvas_id}/pages")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.moda.app/v1/canvases/{canvas_id}/pages")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "canvas_name": "<string>",
  "pages": [
    {}
  ],
  "total_pages": 123,
  "id_note": "<string>"
}
{
  "type": "invalid_request",
  "code": "<string>",
  "message": "<string>",
  "doc_url": "<string>",
  "request_id": "<string>",
  "causes": [
    "<unknown>"
  ],
  "details": {},
  "retry_after_ms": 123,
  "retryable": true
}
{
  "type": "invalid_request",
  "code": "<string>",
  "message": "<string>",
  "doc_url": "<string>",
  "request_id": "<string>",
  "causes": [
    "<unknown>"
  ],
  "details": {},
  "retry_after_ms": 123,
  "retryable": true
}
{
  "type": "invalid_request",
  "code": "<string>",
  "message": "<string>",
  "doc_url": "<string>",
  "request_id": "<string>",
  "causes": [
    "<unknown>"
  ],
  "details": {},
  "retry_after_ms": 123,
  "retryable": true
}
{
  "type": "invalid_request",
  "code": "<string>",
  "message": "<string>",
  "doc_url": "<string>",
  "request_id": "<string>",
  "causes": [
    "<unknown>"
  ],
  "details": {},
  "retry_after_ms": 123,
  "retryable": true
}
{
  "type": "invalid_request",
  "code": "<string>",
  "message": "<string>",
  "doc_url": "<string>",
  "request_id": "<string>",
  "causes": [
    "<unknown>"
  ],
  "details": {},
  "retry_after_ms": 123,
  "retryable": true
}
{
  "type": "invalid_request",
  "code": "<string>",
  "message": "<string>",
  "doc_url": "<string>",
  "request_id": "<string>",
  "causes": [
    "<unknown>"
  ],
  "details": {},
  "retry_after_ms": 123,
  "retryable": true
}
{
  "type": "invalid_request",
  "code": "<string>",
  "message": "<string>",
  "doc_url": "<string>",
  "request_id": "<string>",
  "causes": [
    "<unknown>"
  ],
  "details": {},
  "retry_after_ms": 123,
  "retryable": true
}
{
  "type": "invalid_request",
  "code": "<string>",
  "message": "<string>",
  "doc_url": "<string>",
  "request_id": "<string>",
  "causes": [
    "<unknown>"
  ],
  "details": {},
  "retry_after_ms": 123,
  "retryable": true
}

Authorizations

Authorization

string

header

required

API key from Settings > Developer > REST API

Headers

Layovelle-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) — 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.

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

Page objects with id, name, dimensions, and element counts. Which identifier to use depends on the endpoint: the authoring and capture endpoints (markup, edit, screenshot) take the id, while the semantic-read and export endpoints (design, tokens, export) take the page_number ordinal. Prefer id where it is accepted: an ordinal renumbers when a page is deleted or reordered, so it names a different page over time. id is either a durable real page id or a session-scoped short ref (p_a) — see id_note, returned whenever short refs are present, for the short-ref lifetime; re-list to refresh rather than storing one. A page-less canvas lists one entry with no id.

total_pages

integer

required

Total number of pages in the canvas.

id_note

string | null

Present only when pages[].id carries session-scoped short refs: states their lifetime, and that a real id is accepted anywhere a short ref is. Absent when every id returned is already a durable real page id.