Skip to main content
Version: Next

Canvases

Endpoints related to Canvases.

MethodEndpointPath
DELETEDelete canvases/api/v1/canvas/
GETGet canvas/api/v1/canvas/
POSTCreate a canvas/api/v1/canvas/
GETGet canvas info/api/v1/canvas/_info
GETGet a canvas' definition/api/v1/canvas/{id_or_uuid}/definition
PATCHApply operations to a canvas' definition/api/v1/canvas/{id_or_uuid}/definition
GETGet a canvas' definition changes since a revision/api/v1/canvas/{id_or_uuid}/definition/changes
POSTStart a private draft of a canvas/api/v1/canvas/{id_or_uuid}/draft
POSTGet a placement's data/api/v1/canvas/{id_or_uuid}/placement/{placement_id}/data
DELETEDelete a canvas/api/v1/canvas/{pk}
GETGet canvas by pk/api/v1/canvas/{pk}
PUTUpdate a canvas' title, description and sharing/api/v1/canvas/{pk}
DELETEDelete a canvas draft/api/v1/canvas/draft
GETGet a canvas draft/api/v1/canvas/draft
PATCHApply operations to a canvas draft/api/v1/canvas/draft
POSTCommit a canvas draft/api/v1/canvas/draft/commit
GETGet related fields data (canvas-related-column-name)/api/v1/canvas/related/{column_name}
GETGet the canvas definition schema and widget behavior/api/v1/canvas/schema