Skip to main content
TroopyDocs
Open Troopy
Troopy

API reference / Account

Your board

My board: your own board, with the columns that you made and the cards in them. It is private, and it is the same in each of your workspaces. No other person and no teammate reads it. For an API key, you are the person who made it. A new board has the columns To do, In progress and Done.

get/api/v1/me/board

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 board show
MCP toolNone. Call it over REST or with the CLI.
Rate limit120 calls in 60 seconds, for each key

Response

200 ยท application/json
data*object
2 properties
columns*array<object>

The columns, in their order

3 properties
id*string

A 24-character id

name*string
color*enum<string>

noneskymintsandroseorangecyan

cards*array<object>

The cards, by column and then from the top of each column

10 properties
id*string

A 24-character id

columnId*string

The column that it is in

title*string
notes*string

Plain text. Empty when the card has none

due*string | null

The day it is due, as YYYY-MM-DD

emoji*string | null

The emoji that is its thumbnail. Null with an image, and with no thumbnail

imageUrl*string | null

The address of the image that is its thumbnail. Null with an emoji, and with no thumbnail

workspace*object | null

The workspace that the card is about. Null with no tag, and for a workspace that you no longer reach

3 properties
id*string

A 24-character id

name*string
logoUrl*string | null
createdAt*string

ISO 8601 date and time

updatedAt*string

ISO 8601 date and time

Errors

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