> ## 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. # List Canvases > List canvases accessible to the API key's team (cursor pagination). Returns at most ``limit`` canvases per page (default 20, cap 100). No cheap true ``total`` exists on this lane (the doc-kind filter reads un-indexed JSONB, so an exact count would scan every canvas document) — ``has_more`` is always explicit instead: iterate ``next_cursor`` while it is ``true`` to fetch everything. ## OpenAPI ````yaml /openapi/moda-public-api.yaml get /canvases openapi: 3.1.0 info: title: Moda Public API description: > Programmatic access to Moda's canvas design platform. Create designs, export assets, manage brand kits, and run AI design tasks. ## Versioning Pin response shapes with a calendar-dated `Moda-Version` header (e.g. `2026-05-01`). **The pin is global** — it applies to every endpoint in the request, not just the one you adopted it for, so raising it to use a new endpoint also moves your other responses to that version's shapes. ### Migrating `2026-04-12` → `2026-05-01` - **Tasks** move from the flat `JobResponse` (`job_id`, `canvas_url`, `can_export`) to the canonical `Task` envelope. The export artifact is now under `result.export` as `{url, format, page_count}`; update any code that read the export URL from the old top-level fields. - **Multi-page PNG/JPEG exports are delivered as a single `.zip`** of per-page files (`page-1.png`, …), so `result.export.format` is `zip`. For one bundled document instead, request `format=pdf` or `pptx`; for a single image, pass `page_number`. version: 1.0.0 x-moda-api-version: '2026-05-01' servers: - url: https://api.moda.app/v1 description: Production security: [] tags: - name: canvases description: List, search, read, export, and share canvases - name: tasks description: Start and monitor AI design tasks - name: organizations description: List organizations and teams - name: credits description: Check credit balance and usage - name: brand-kits description: Manage brand kits - name: remix description: Duplicate and edit canvases - name: share-links description: Resolve share URLs to canvas identifiers - name: uploads description: Upload files for use as attachments - name: usage description: Aggregate API usage stats for the caller's team - name: embed description: Signed iframe embed sessions - name: web description: 'Metered web research: search and page reading' - name: websites description: >- Create, update, publish, screenshot, and manage hosted multi-page static sites - name: drive description: >- Organize the workspace: folders, the folder tree, and item move/rename/visibility/delete for folders, canvases, and files paths: /canvases: get: tags: - canvases summary: List Canvases description: >- List canvases accessible to the API key's team (cursor pagination). Returns at most ``limit`` canvases per page (default 20, cap 100). No cheap true ``total`` exists on this lane (the doc-kind filter reads un-indexed JSONB, so an exact count would scan every canvas document) — ``has_more`` is always explicit instead: iterate ``next_cursor`` while it is ``true`` to fetch everything. operationId: listCanvases parameters: - name: cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: >- Opaque pagination cursor. Pass the ``next_cursor`` from the previous response. Omit on the first request. title: Cursor description: >- Opaque pagination cursor. Pass the ``next_cursor`` from the previous response. Omit on the first request. - name: limit in: query required: false schema: type: integer maximum: 100 minimum: 1 description: Max canvases per page. Defaults to 20, caps at 100. default: 20 title: Limit description: Max canvases per page. Defaults to 20, caps at 100. - $ref: '#/components/parameters/ModaVersion' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ListCanvasesResponse' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '403': description: Permission denied for this scope. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '404': description: Resource not found. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '409': description: Conflict (idempotency / resource state). content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '422': description: Request validation failed. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '429': description: Rate limit exceeded. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '500': description: Internal error. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' security: - API Key: [] components: parameters: ModaVersion: name: Moda-Version in: header required: false description: >- 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](/api-reference/versioning). Any unsupported value returns 400 `unsupported_version`. example: '2026-05-01' schema: type: string enum: - '2026-04-12' - '2026-05-01' default: '2026-05-01' example: '2026-05-01' schemas: ListCanvasesResponse: properties: data: items: $ref: '#/components/schemas/CanvasItem' type: array title: Data description: Canvases in this page, newest first. next_cursor: anyOf: - type: string - type: 'null' title: Next Cursor description: >- Opaque cursor to pass as ``?cursor=`` on the next request. ``null`` means you've reached the end of the collection. returned: type: integer title: Returned description: >- Number of items in this page (always ``len(data)``; derived server-side). default: 0 has_more: type: boolean title: Has More description: >- ``true`` when more items exist beyond this page — keep requesting with ``next_cursor`` until this is ``false``. Never trust ``len(data) < limit`` alone. default: false limit: anyOf: - type: integer - type: 'null' title: Limit description: The effective page-size limit this response was computed with. total: anyOf: - type: integer - type: 'null' title: Total description: >- True total number of items in the collection (after filters), when the endpoint can count cheaply. ``null`` on log/search lanes — use ``has_more`` there. type: object required: - data title: ListCanvasesResponse description: |- Cursor-paginated canvas list response (ENG-2377). Callers pass ``?cursor=`` on subsequent requests; ``next_cursor`` is ``null`` when there are no more rows. ``returned`` and ``has_more`` are derived server-side; ``total`` stays ``null`` on this lane (the doc-kind filter reads un-indexed JSONB, making an exact count as expensive as a full scan) — rely on ``has_more``. See ``/api/versioning`` for the legacy-to-cursor migration map. ErrorEnvelope: properties: type: $ref: '#/components/schemas/ErrorType' code: type: string title: Code description: >- Stable machine string keyed to doc_url. Never changes once published. message: type: string title: Message description: >- Human-readable message, for developers. Not localized, not user-facing. doc_url: type: string title: Doc Url description: Permalink to the docs page for this code. request_id: anyOf: - type: string - type: 'null' title: Request Id description: Correlator for logs/Sentry/audit. causes: anyOf: - items: $ref: '#/components/schemas/ErrorEnvelope' type: array - type: 'null' title: Causes description: Aggregated upstream failures (e.g. per-page export errors). details: anyOf: - additionalProperties: true type: object - type: 'null' title: Details description: >- Code-specific detail payload (e.g. validation field list). Callers should pass ``None`` rather than ``{}`` to omit the key from the response. retry_after_ms: anyOf: - type: integer - type: 'null' title: Retry After Ms description: Hint for rate-limited or transient errors. retryable: anyOf: - type: boolean - type: 'null' title: Retryable description: >- Explicit retryability for this code, from the error-code registry: ``false`` means retrying the same request cannot succeed (fix the input / resource first); ``true`` means the condition is transient and a retry (with backoff / after the blocker clears) can succeed. Omitted for codes whose retryability is context-dependent — do not derive it from ``type`` or the HTTP status when this field is present. type: object required: - type - code - message - doc_url title: ErrorEnvelope description: >- Canonical error payload, nested under the top-level ``{"error": ...}`` key. CanvasItem: properties: id: type: string pattern: ^cvs_[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$ title: Id description: Unique canvas identifier (prefixed ``cvs_...``). example: cvs_01HT9WK8N3M2J4A5Z6P7Q8R9TV name: type: string title: Name description: Display name of the canvas. url: type: string title: Url description: Full URL to open the canvas in the Moda editor. category: anyOf: - type: string - type: 'null' title: Category description: >- Canvas format category — one of ``slides``, ``social``, ``carousel``, ``pdf``, ``diagram``, ``ui``, ``animation``, ``prints``, ``web-ads``, ``other``, or ``null`` when unset. Use this to distinguish slide decks from social posts etc. in list UIs. visibility: anyOf: - type: string - type: 'null' title: Visibility description: >- Canvas visibility — ``team`` (visible to everyone on the team) or ``private`` (only the creator and explicit shares). created_at: anyOf: - type: string - type: 'null' title: Created At description: ISO 8601 timestamp when the canvas was created. updated_at: anyOf: - type: string - type: 'null' title: Updated At description: ISO 8601 timestamp of the last modification. created_by: anyOf: - $ref: '#/components/schemas/CreatorInfo' - type: 'null' description: >- Canvas creator (id, name, email). ``null`` when the creator user has been deleted or the relationship failed to load. template_type: anyOf: - type: string - type: 'null' title: Template Type description: '''template'', ''theme'', or null.' type: object required: - id - name - url title: CanvasItem ErrorType: type: string enum: - invalid_request - authentication - permission - not_found - conflict - rate_limited - idempotency_conflict - unprocessable - upstream_error - internal_error title: ErrorType description: Closed set of high-level categories SDKs branch on. CreatorInfo: properties: id: type: string title: Id description: User ID of the creator. name: type: string title: Name description: Display name of the creator. email: type: string title: Email description: Email address of the creator. type: object required: - id - name - email title: CreatorInfo description: Minimal creator attribution for list/search responses. securitySchemes: API Key: type: http description: API key from Settings > Developer > REST API scheme: bearer ````