Skip to main content
TroopyDocs
Open Troopy
Troopy

API reference / Account

Your notifications

What Troopy told you about in this workspace, the newest first: decisions that wait for you, work to review, drafts, replies and more, as you chose in Settings > Notifications. Pass next as cursor for the page after.

get/api/v1/me/notifications

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

Query parameters

unreadboolean | enum<string>

true: only what you have not read

truefalse

limitinteger

At most 100

Default 30 · At least 1 · At most 100

cursorstring

The next value from the previous page

At most 200 characters

Response

200 · application/json
data*array<object>
9 properties
id*string

A 24-character id

kind*enum<string>

decisionreviewtaskdraftreplymailroutine_doneroutine_failedweeklyremindersessionmentionvisitor

by*object | null

Who did it. Null for Troopy itself

4 properties
type*enum<string>

personagentapi

id*string
name*string
handle*string | null

A teammate's handle, for its face. Null for a person, or for a teammate that left

verb*string

The words between the name and the title, like needs your decision on

title*string

What it is about, like VIR-12 Write the newsletter

text*string

Its first words

href*string

Its page in the app, as a path

read*boolean
at*string

ISO 8601 date and time

unread*integer

What is still unread in the bell

next*string | null

Pass as cursor for the next page; null on the last

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.