Skip to main content
TroopyDocs
Open Troopy
Troopy

API reference / Account

Stop your Mac session

Ends each session on your Mac at once: the teammate stops, and Troopy for Mac puts the windows back. A teammate needs a new yes to use your Mac again.

post/api/v1/me/mac/stop

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 stop
MCP toolNone. Call it over REST or with the CLI.
Rate limit10 calls in 60 seconds, for each key
RetriesSend an Idempotency-Key header. A retry with the same key gets the first answer back, and the operation runs one time.

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.
409 conflictThis Idempotency-Key was used for a different request, or that request is still running. Use a new key for a new request.
429 rate_limitedWait the number of seconds in Retry-After, then retry.