How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Cube Canvases API

The Canvases API from Cube — 10 operation(s) for canvases.

Cube Canvases API is one of 42 APIs that Cube publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Canvases. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and API documentation.

This API exposes 18 operations across 10 paths, and defines 22 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0 (1.0).

Requests are made against a single base URL, https://api.cubesoftware.com.

18 operations 10 paths 22 schemas 4 DELETE4 GET3 PATCH6 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0 (1.0)
Base URL
https://api.cubesoftware.com
Authentication
OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 1

Cube Canvases API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow.

  • OAuth2 — Standard Cube OAuth 2.0 flow

Paths & Operations 18

Across 10 paths, the API surfaces 18 operations — 4 DELETE, 4 GET, 3 PATCH, 6 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Canvases 18
GET
/canvases
List all canvases.
canvases_list 2 params → 200
POST
/canvases
Create a new canvas.
canvases_create body → 201
POST
/canvases/{canvas_pk}/tabs
Create a new canvas tab.
canvases_tabs_create 1 param body → 201
PATCH
/canvases/{canvas_pk}/tabs/{id}
Update specific fields of a canvas tab.
canvases_tabs_partial_update 2 params body → 200
DELETE
/canvases/{canvas_pk}/tabs/{id}
Delete a canvas tab.
canvases_tabs_destroy 2 params → 204
PUT
/canvases/{canvas_pk}/tabs/{id}/layout
Associate widgets with a canvas tab.
canvases_tabs_layout_update 2 params body → 200
GET
/canvases/{id}
Retrieve a specific canvas
canvases_retrieve 1 param → 200
PATCH
/canvases/{id}
Partially update a canvas by ID.
canvases_partial_update 1 param body → 200400
DELETE
/canvases/{id}
Delete a canvas.
canvases_destroy 1 param → 204
POST
/canvases/{id}/duplicate
Duplicate a canvas.
canvases_duplicate_create 1 param body → 200
POST
/canvases/{id}/like
Like a canvas
canvases_like_create 1 param body → 200
DELETE
/canvases/{id}/like
Undo a canvas like.
canvases_like_destroy 1 param → 204
GET
/canvases/widgets
List all widgets.
canvases_widgets_list → 200
POST
/canvases/widgets
Create a new widget.
canvases_widgets_create body → 201
GET
/canvases/widgets/{id}
Retrieve details of a specific widget.
canvases_widgets_retrieve 1 param → 200
PATCH
/canvases/widgets/{id}
Update specific fields of a widget.
canvases_widgets_partial_update 1 param body → 200
DELETE
/canvases/widgets/{id}
This is a shortcut class that will include all 6 resourceful actions part of the DRF ViewSets: - list() - retrieve() - create() - update() - partialupdate() - destroy() If you do not want to expose a…
canvases_widgets_destroy 1 param → 204
POST
/canvases/widgets/{id}/render
Generate a screenshot of a widget component.
canvases_widgets_render_create 1 param body → 200400404500

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are Canvas (12 properties), PatchedCanvas (12 properties), CanvasListSchema (10 properties), User (9 properties). Each schema is shown below with its type and property counts.

RelationshipTypeEnum
string
EMPLOYEE - Employee PARTNER - Partner
error_response_serializer
object
2 properties 2 required
SharingScheme2f1Enum
string
ALL - All Team Members MANAGERS - Managers Only SPECIFIC - Specific Users
metadata_serializer
object
4 properties 4 required
User
object
A serializer mixin that allows dynamic inclusion or exclusion of serializer fields by passing fields=[...] or excludefields=[...] when initializing.
9 properties 5 required
Source251Enum
string
WORKSPACE - Workspace DECKS - Decks MCP - MCP PLANMODE - Plan Mode
CanvasTabWidget
object
5 properties 3 required
VisualTypeEnum
string
TEXT - Text DATATABLE - Data Table LINE - Line Chart BAR - Bar Chart ROW - Row Chart COMBO - Combo Chart PIE - Pie Chart DONUT - Donut Chart METRIC - Metric TR…
WidgetRenderFilter
object
2 properties 2 required
Canvas
object
Mixin to delegate create and update operations to a service class.
12 properties 5 required
TimezoneEnum
string
Africa/Abidjan - Africa/Abidjan Africa/Accra - Africa/Accra Africa/AddisAbaba - Africa/AddisAbaba Africa/Algiers - Africa/Algiers Africa/Asmara - Africa/Asmara…
PatchedCanvas
object
Mixin to delegate create and update operations to a service class.
12 properties
WidgetTypeEnum
string
RANGE - Range TEMPLATE - Template TEXT - Text
CanvasListSchema
object
10 properties 5 required
WidgetRenderRequest
object
6 properties
CanvasTab
object
Mixin to delegate create and update operations to a service class.
4 properties 2 required
NullEnum
Widget
object
A serializer that conditionally includes optional fields based on context. Optional fields should be listed in Meta.readoptionalfields. To include them in the…
6 properties 4 required
PatchedCanvasTab
object
Mixin to delegate create and update operations to a service class.
5 properties
PatchedWidget
object
A serializer that conditionally includes optional fields based on context. Optional fields should be listed in Meta.readoptionalfields. To include them in the…
6 properties
BlankEnum
WidgetDataSource
object
5 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cubesoftware-canvases-api-openapi.yml Raw ↑

Other APIs Cube publishes across the network.

Cube Agents API
Cube Attributes API
Cube Audit Trail API
Cube Auth API
Cube Authentication API
Cube ChatMessages API
Cube ChatSessions API
Cube ChatSettings API
Cube Comments API
Cube Companies API
Cube Company Groups API
Cube compliance API
Where this information came from

This is an independent, third-party profile of Cube Canvases API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.