Skip to main content
GET
List canvases

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

projectId
string<uuid>

Restrict results to canvases in this project.

workspaceId
string<uuid>

Restrict results to this workspace id. Results are always scoped to the authenticated workspace, so this is only useful when it matches.

includePromotedVersion
boolean

When true, each canvas includes promotedVersion and latestVersion.

personal
boolean

When true, only the caller's personal drafts (projectId is null) are returned. Returns an empty list for tokens without a user identity.

Response

List of canvases.

id
string<uuid>
required
title
string
required
Maximum string length: 256
projectId
string<uuid> | null
required

Project the canvas belongs to. null for the caller's personal drafts.

inferencesPercentage
string
required

Share of live inferences sampled for review, as a decimal string (for example "0.10").

layoutVersion
string
required

Editor layout version (v1 or v2).

workspaceId
string<uuid>
required
customTags
string[]
required
createdBy
string
required
updatedBy
string
required
allowedCredentials
string[] | null

Credential ids the canvas may use. null means unrestricted.

deletedBy
string | null
createdAt
string<date-time> | null
updatedAt
string<date-time> | null
deletedAt
string<date-time> | null
favorited
boolean

Whether the calling user favorited the canvas. Only present when the token carries a user identity.

promotedVersion
object | null

Production version. Only present when includePromotedVersion=true; null when the canvas has no production or promoted version.

latestVersion
object | null

Most recently created version. Only present when includePromotedVersion=true; null when the canvas has no versions.