Skip to main content
TroopyDocs
Open Troopy
Troopy

API reference / Account

Your Mac

Whether your own Mac is online for teammates through Troopy for Mac, the apps that it offers, and the session in progress. A teammate works in those apps only after you say yes to a session in Troopy for Mac.

get/api/v1/me/mac

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

Response

200 · application/json
data*object
6 properties
canLend*boolean

Whether you may lend a Mac here. A viewer, an approver or a guest may not

off*boolean

Whether owners and admins switched Mac sessions off for this workspace

online*boolean

Whether Troopy for Mac on your Mac offers it to teammates now

name*string | null

The name of the Mac, while it is online

apps*array<object>

The apps that the Mac offers to teammates

2 properties
id*string
name*string
session*object | null

The session that you said yes to, while it lasts

6 properties
agent*string

The name of the teammate

handle*string

The teammate's handle, like chief

At most 40 characters

task*string

What it does

apps*array<string>

The names of the apps of the session

visible*boolean

Whether it takes over the screen, in place of the hidden display

until*string

When the session ends

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.