API reference / Account
Get the company
The company 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. Owners and admins also get the legal details (legal).
/api/v1/companyOther ways to call it
troopy company gettroopy_get_companyResponse
200 · application/jsondata*object8 properties
id*stringA 24-character id
name*stringrole*enum<string>Role in the company. Owners and admins reach every workspace in it, and manage its people. A member reaches only the workspaces that someone invited it into. An accountant reaches no workspace: it reads the Portfolio and the reports of the company in the app, and changes nothing
owneradminmemberaccountant
aiProvider*enum<string> | nullThe AI plan teammates run on. Null until setup picks one
claudechatgptgeminigrokcopilotopenrouterzaikimiminimaxqwenanthropicopenaicursor
troopNames*enum<string> | nullWhere 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*objectSetup'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
legal*object | nullThe legal details of the company: its legal entity. Null for a person who is not an owner or admin
8 properties
legalName*string | nullThe registered name of the company
entityType*string | nullThe legal form, like BV, GmbH, Ltd or LLC
registrationNumber*string | nullThe number in the register of companies
address*string | nullThe registered address
country*string | nullThe country of the company, ISO 3166-1 alpha-2, like NL
currency*string | nullThe currency of the books of the company, ISO 4217, like EUR. Its totals are in it
taxIds*array<object>The tax ids of the company, like VAT or EIN, 5 at most. Data of the business, not a secret
At most 5 items
2 properties
label*stringAt least 1 characters · At most 40 characters
value*stringAt least 1 characters · At most 60 characters
fiscalYearStart*integerThe month that the fiscal year starts in: 1 is January
At least 1 · At most 12
logoUrl*string | nullA public link to the company's logo, or null when it has none