API reference / Canvas
List canvases
The workspace's canvases, the whiteboards its people and teammates draw on together, most recently changed first.
get
/api/v1/canvasesOther ways to call it
CLI
troopy canvases listMCP tool
troopy_list_canvasesRate limit120 calls in 60 seconds, for each key
Query parameters
pageinteger1-based page number
Default 1 · At least 1
limitintegerItems per page, at most 100
Default 20 · At least 1 · At most 100
Response
200 · application/jsondata*array<object>6 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
pagination*object4 properties
page*integerlimit*integertotal*integerpages*integerErrors
400 invalid_inputFix the field named in detail. Each operation's schema is in /api/v1/openapi.json.
401 unauthorizedSend an API key as `Authorization: Bearer tr_live_...`. Create one in Troopy under Settings.
403 forbiddenThe key lacks a scope this operation needs, or its owner lacks the role. detail says which; create a key with the scope, or ask an organization owner or admin.
429 rate_limitedWait the number of seconds in Retry-After, then retry.