API reference / Canvas
Share a canvas with a link
Gives a canvas a guest link people without an account can open: view to look, edit to change it too (guests can't upload images, turn things into tasks or ask the troop). off takes the link away, and reset gives a new one, so the old one stops working; either closes guests' open boards at once. Whoever created the canvas, owners and admins.
patch
/api/v1/canvases/{id}/shareOther ways to call it
CLI
troopy canvases shareMCP toolNone. Call it over REST or with the CLI.
Rate limit30 calls in 60 seconds, for each key
Path parameters
id*stringA 24-character id
Body
application/jsonmode*enum<string>offviewedit
resetbooleanA new link: the old one stops working
Response
200 · application/jsondata*object1 properties
share*object | nullIts guest link, when there is one: view to look, edit to change it too
2 properties
mode*enum<string>viewedit
url*stringAnyone with it can open the canvas: keep it to those it's for
Errors
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.
404 not_foundCheck the path and any id in it. Every operation is listed in /api/v1/openapi.json.
429 rate_limitedWait the number of seconds in Retry-After, then retry.