Skip to main content
TroopyDocs
Open Troopy
Troopy

API reference / Apps

List the custom apps

The apps that this workspace added itself: remote MCP servers, each with its tools and the mode of each tool. Teammates call a tool with call_app_tool. A tool in the mode ask waits for the yes of an owner or admin. No key or token ever comes out.

get/api/v1/custom-apps

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.
Scopesapps:read

Other ways to call it

CLItroopy custom-apps list
MCP tooltroopy_list_custom_apps
Rate limit30 calls in 60 seconds, for each key

Response

200 · application/json
data*array<object>
12 properties
slug*string

The id of the app, made from its name, as in acme_crm

name*string
kind*enum<string>

A remote MCP server, or an OpenAPI document (Liquid SaaS)

mcpopenapi

url*string

The Streamable HTTP address of its MCP server

auth*enum<string>

How Troopy signs in: nothing, a key in a header, or the sign-in of the server

nonekeyoauth

status*enum<string>

connectedneeds_sign_infailed

error*string | null
tools*array<object>
5 properties
name*string
description*string
mode*enum<string>

free: it runs. ask: it waits for the yes of an owner or admin. off: no teammate calls it

freeaskoff

args*array<string>

The top-level arguments of the tool

visitor*string | null

The argument that takes the email of a visitor of the website. Then the Support agent calls the tool for a visitor that the website proved, and Troopy fills that argument in. Null: the Support agent never calls it

listedAt*string | null

When an owner or admin last read its tools

connectedBy*object

Who wrote it

3 properties
type*enum<string>

personagentapi

id*string
name*string
connectedAt*string

ISO 8601 date and time

signIn*string | null

The page that starts the sign-in of the server, while it waits for one. A person opens it

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.