Skip to main content
TroopyDocs
Open Troopy
Troopy

API reference / Analytics

Share the public dashboard

Turns on a live, read-only view of the workspace at a link that anyone can open. It shows the troop and its status, the board with the thread of each task, and Docs. It shows no email, settings or vault, no CRM, Customers or Analytics, and no files on tasks. Tasks that hold the words of customers, leads or senders of mail stay out too. on false stops the link, and on true brings the same link back. reset gives a new link, and the old one stops working. indexable lets search engines index the view. Send no field to read it as it is. Owners and admins.

patch/api/v1/public-dashboard

Authorization

HeaderAuthorization: Bearer <API key>
Or the headerX-API-Key: <API key>
API keyMake one in Troopy under Settings > API keys. It acts as you, in its workspace.

Other ways to call it

CLItroopy workspace dashboard
MCP toolNone. Call it over REST or with the CLI.
Rate limit30 calls in 60 seconds, for each key

Body

application/json
onboolean

Whether the link opens the view

resetboolean

A new link: the old one stops working

indexableboolean

Whether search engines may index the view. Off at first

Response

200 · application/json
data*object
3 properties
on*boolean

Whether the link opens the view

indexable*boolean

Whether search engines may index the view

url*string | null

The link of the view. It is there while the view is off too, so that on brings it back

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.
429 rate_limitedWait the number of seconds in Retry-After, then retry.