SpecifyDocs

canvas_list

tools/call

List the canvases you can read: your workspace canvases (private or shared with the workspace) and the canvases in projects, or in one project. Each has its canvasId, title, where it lives, its size and its last change.

Scopes

read:projects

A project canvas also needs its project to be readable, and for writes writable (Edit tasks, not archived) by the key's person. A workspace canvas is readable when its person owns it or it is shared with the workspace, and writable when its person owns it or holds Edit tasks on a shared one.

Inputs

projectstring
Project name, key (PAY) or ID. Omit for workspace canvases and every project.
view"all" | "mine" | "shared" | "recent"
all (default), mine (made by your person), shared (shared with the workspace), recent (last changed first).
cursorstring
limitinteger

Returns

One page of canvases and the next cursor. A call returns content[0].text with the JSON result and structuredContent.result with the same value.

Listed when

The key has read:projects and Canvas is open for the workspace; the tools that write need write:projects too.