Skip to main content
TroopyDocs
Open Troopy
Troopy

API reference / Account

Get the organization

The organization the key's workspace belongs to: its name, the caller's role in it, the AI plan its teammates run on, where their names come from and its answers to setup's survey.

get/api/v1/organization

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 organization get
MCP tooltroopy_get_organization
Rate limit120 calls in 60 seconds, for each key

Response

200 · application/json
data*object
6 properties
id*string

A 24-character id

name*string
role*enum<string>

Role in the organization. Owners and admins reach every workspace in it, and manage its people. A member reaches only the workspaces that someone invited it into

owneradminmember

aiProvider*enum<string> | null

The AI plan teammates run on. Null until setup picks one

claudechatgptgeminigrokcopilotopenrouterzaikimiminimaxqwenanthropicopenaicursor

troopNames*enum<string> | null

Where new teammates' names come from: a theme, or their job titles (titles). Null until setup asks, which names them by job title

titlesgreek-mythgreek-heroesnorsecamelotspacescientistsexplorersauthorscomposersbirdstreesoceangemstonesspicescoffeeand 11 more

profile*object

Setup's survey about the business. Unanswered questions are missing

8 properties
teamSizeenum<string>

How many people work in the business

solo2_1011_5051_200over_200

revenueenum<string>

Monthly revenue, in USD

noneunder_10k10k_50k50k_250k250k_1mover_1m

jobRoleenum<string>

The role of whoever answered

founderexecutivemarketingsalesoperationssupportproductagencyother

businessModelenum<string>

saasecommerceagencyserviceslocalmarketplacecreatorother

industriesarray<enum<string>>

technologyretailhealthfinanceeducationreal_estatehospitalitymediaprofessionalother

At most 10 items

reasonenum<string>

The main reason they signed up

save_timefewer_toolsgrow_without_hiringalways_onexplore_aiother

jobsarray<enum<string>>

What they want their teammates to do

outreachlead_researchsupportsocialcontentseoemailbookkeepingrecruitingreportingengineering

At most 11 items

referralsarray<enum<string>>

How they heard about Troopy

googleai_assistantxlinkedinyoutuberedditproduct_huntfriendnewsletterother

At most 10 items

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.