Canvases API

Use canvases for shared boards that sit inside projects. The API manages canvas records; canvas object editing remains app-side.

Endpoints

List canvases in the authenticated workspace

Scope

canvas:read

Parameters

projectIdstringFilter by project ID

includeArchivedbooleanInclude archived canvases when true

limitnumberNumber of canvases (max 100, default 50)

cursorstringComposite pagination cursor from the previous page

Response

{
  "items": [
    {
      "id": "cnv_abc123",
      "projectId": "prj_xyz789",
      "name": "Launch flow map",
      "description": "Review board for launch dependencies",
      "visibility": "shared",
      "archived": false,
      "updatedAt": 1779680000000
    }
  ],
  "nextCursor": null
}

Create a canvas

Scope

canvas:write

Parameters

projectIdstringrequiredProject that owns the canvas

namestringrequiredCanvas name, 200 characters or less

descriptionstringOptional description

visibilitystringprivate or shared

Get one canvas by ID

Scope

canvas:read

Parameters

idstringrequiredCanvas ID (URL path)

Update canvas metadata

Scope

canvas:write

Parameters

idstringrequiredCanvas ID (URL path)

namestringNew name

descriptionstringNew description

visibilitystringprivate or shared

Archive a canvas

Scope

canvas:write

Parameters

idstringrequiredCanvas ID (URL path)

Restore an archived canvas

Scope

canvas:write

Parameters

idstringrequiredCanvas ID (URL path)

Delete a canvas

Scope

canvas:write

Parameters

idstringrequiredCanvas ID (URL path)