API reference / Canvas
Get a canvas
One canvas. view=full (the default) gives every item on it; view=text gives an outline to read: each frame's title with the notes, text and shapes inside it, then the rest, each with its key, then the open comments. A long outline comes a page at a time (about 4,000 characters): its last line, and nextOffset, say which offset reads on.
/api/v1/canvases/{id}Other ways to call it
troopy canvases gettroopy_get_canvasPath parameters
id*stringA 24-character id
Query parameters
viewenum<string>fulltext
Default "full"
offsetintegerWith view=text: the outline line to start at, to read on from a cut one
Default 0 · At least 0
Response
200 · application/jsondata*object13 properties
id*stringA 24-character id
name*stringcreatedBy*objectWho wrote it
3 properties
type*enum<string>personagentapi
id*stringname*stringlastEditedBy*object | nullWho changed it last
3 properties
type*enum<string>personagentapi
id*stringname*stringcreatedAt*stringISO 8601 date and time
updatedAt*stringISO 8601 date and time
seq*integerIts latest change's number
timer*object | nullIts meeting timer: counting down, paused, or null when none is set
2 properties
running*booleanleft*integerMilliseconds left
private*object | nullPrivate mode, while it is on: what people add stays hidden from others until it ends
1 properties
by*object2 properties
id*stringname*stringshare*object | nullWhether it has a guest link: view to look, edit to change it too. Only sharing it gives the link itself
1 properties
mode*enum<string>viewedit
itemsarray<object>Everything on it, bottom first (view=full)
23 properties
xnumberLeft edge, in canvas units
At least -1000000 · At most 1000000
ynumberTop edge, in canvas units
At least -1000000 · At most 1000000
wnumberWidth
At least 0 · At most 100000
hnumberHeight
At least 0 · At most 100000
znumberStacking order: higher sits on top
At least -1000000000000 · At most 1000000000000
colorenum<string>sandpeachrosemintskycyanorangestoneink
textstringWhat a note, text or shape says, or a frame's title
At most 5000 characters
shapeenum<string>rectellipse
fromobjectWhere an arrow starts: an item it follows, or a point
1 properties
key*stringThe item's key, unique on its canvas
toobjectWhere an arrow ends: an item it follows, or a point
1 properties
key*stringThe item's key, unique on its canvas
pointsarray<number>A pen stroke: x, y pairs, from the item's x and y
At most 4000 items
widthnumberA pen stroke's or arrow's thickness
At least 1 · At most 64
filestringAn image's file, as uploading it named it
voterstringA vote's voter: the person's user id. A vote's to is the note it is for
taskstringThe task a note became, by its key (like VIR-12)
authorobjectA comment's writer: only they change or delete it
2 properties
id*stringAt most 64 characters
name*stringAt least 1 characters · At most 80 characters
threadstringA reply's comment: the first comment of its thread
resolvedbooleanA thread settled: its pin hides
atstringWhen a comment was written (set by Troopy)
date-time
privateTostringHidden from everyone but this person while private mode is on (set by Troopy)
At most 64 characters
guestbooleanAdded by a guest, through the canvas's link (set by Troopy)
key*stringThe item's key, unique on its canvas
type*enum<string>stickytextshapearrowpenframeimagevotecomment
outlinestringIts frames, notes, text and shapes with words, one a line with its key, by frame (view=text). A long one is cut at about 4,000 characters: its last line says where to read on
nextOffsetinteger | nullWith view=text: the offset that reads on when the outline was cut, else null