CUcubesoftware
Canvases

Retrieve a specific canvas

Changed on

Retrieve details of a specific canvas by ID.

  • Includes all fields, including tabs and shared_with data.
  • This endpoint is intended for viewing a single canvas along with its associated tabs and widgets.
get/canvases/{id}

Request

  • Base URL
    https://api.cubesoftware.com
  • Auth
    OAuth 2
    Authorization code: https://portal.cubesoftware.com/o/authorize/
    Token URL: https://api.cubesoftware.com/o/token/

Path parameters

idstring required

Response

idstring uuid required
namestring 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
filtersunknown
default_currency_idinteger nullable
folder_idinteger nullable
shared_withstring[]
is_likedboolean required
created_atstring date-time required
modified_atstring date-time required

Changes