Sign in

v1

latestOpenAPI 3.1.02026-08-063512102.9 KB

List canvas objects

List all objects in a canvas. The service account must have at least a viewer role for this canvas.

get/v1/canvases/:canvas_key/objects

Path parameters

canvas_keystring required

The unique identifier for the canvas

Query parameters

'cell'

A cell

OR
'component'

A component

OR
'connector'

A connector between objects

OR
'ellipse'

An ellipse

OR
'embed'

An embed (video, bookmark, or iframe)

OR
'frame'

A frame

OR
'group'

A group of objects

OR
'image'

An image

OR
'line'

A line

OR
'pencil'

A freehand pencil drawing

OR
'polygon'

A polygon

OR
'rectangle'

A rectangle

OR
'stamp'

A stamp

OR
'thread'

A comment thread

OR
'text'

A text object

OR
'sticky_note'

A sticky note

The type of canvas object

connection_keystring

The unique identifier for the connection

Response

Successful response

successtrue required
request_idstring required