List canvases
GET/v1/canvases
List all visible canvases in the workspace accessible with this service account. Trashed canvases and those that the service account is not permitted to view are not returned.
Responses
Successful response
success * boolean
request_id * string
result * object
canvases * object[] — The list of canvases in the workspace.
key * string — The unique identifier for the canvas
name * string — The display name for the canvas
created_at * string (date-time) — An ISO 8601 date-time string.
modified_at * string (date-time) | null — An ISO 8601 date-time string, or null.
modified_by * string | null — Who last modified the canvas
creator * string — The unique identifier for the user
permissions * object[] — The list of actors with assigned permissions for this canvas.
key * string — The unique identifier for the actor.
role * "analyst" | "editor" | "viewer" | "reportViewer" — The assigned canvas role
type * "user" | "group" | "serviceAccount" | "workspace" | "project" | "public" — The type of actor.
permitted_actions * object — The actions you are allowed to perform in this canvas
create_agent * boolean — Are you able to create an agent or not.
preview * string | null — A preview image URL for the canvas