Sign in
latestOpenAPI 3.0.32026-08-19299284712.8 KB

67d9f45bb99b

Canvases

List all canvases.

List of all canvases available to the authenticated user company.

  • Results are ordered by creation date, newest first.
  • Each canvas includes basic metadata and an is_liked flag indicating whether the current user has liked it.
  • For performance reasons, related fields such as tabs and shared_with are not included in list responses.
get/canvases

Query parameters

source'BUILDER' | 'DECKS' | 'MCP' | 'PLAN_MODE' | 'WORKSPACE'

Filters the results to canvases with the given source.

  • By default, only WORKSPACE and MCP canvases are returned.
  • Use ?source=DECKS to list only Decks-created canvases.
  • Use ?source=BUILDER to list only Builder-created canvases.
widget_type'RANGE' | 'TEMPLATE' | 'TEXT'

Filters the results to canvases that include at least one widget of the given type.

  • If omitted, no widget-type filtering is applied.

Response

namestring required
{"stackTrail":"components:schemas:CanvasListSchema:properties:filters","oasType":"schema","type":"unknown"}
default_currency_idinteger nullable
is_likedboolean required
idstring uuid required
descriptionstring nullable
sharing_scheme'ALL' | 'MANAGERS' | 'SPECIFIC'
  • ALL - All Team Members
  • MANAGERS - Managers Only
  • SPECIFIC - Specific Users
source'WORKSPACE' | 'DECKS' | 'MCP' | 'PLAN_MODE' | 'BUILDER'
  • WORKSPACE - Workspace
  • DECKS - Decks
  • MCP - MCP
  • PLAN_MODE - Plan Mode
  • BUILDER - Builder
created_atstring date-time required
modified_atstring date-time required