Skip to main content
TroopyDocs
Open Troopy
Troopy

API reference / Account

Your Telegram

Whether your Telegram is linked to this workspace. Once linked, what you send Troopy's bot goes to the Chief of Staff here, and its replies and approvals come back there.

get/api/v1/me/telegram

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 telegram status
MCP tooltroopy_telegram_status
Rate limit60 calls in 60 seconds, for each key

Response

200 · application/json
data*object
7 properties
available*boolean

Whether this Troopy has a Telegram bot set up

bot*string | null

The bot's Telegram username

linked*boolean

Whether your Telegram is linked to this workspace

username*string | null

The linked Telegram account's username, if it has one

linkedAt*string | null
workspaceBot*object | null

The workspace's own bot, named after its lead, once someone made it: people talk to the Chief of Staff there

4 properties
username*string

Its Telegram username

disabled*string | null

Why it stopped answering, or null

canOpen*boolean

Whether Telegram lets you open it: its owner and the first 10 others who connected Telegram here

createdAt*string

ISO 8601 date and time

createBotUrl*string | null

Opens Telegram's create-bot screen, filled in with the lead's name: for owners and admins with Telegram linked, while the workspace has no bot

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