API reference / CRM
Get a company
One company in the CRM, how many of its people the CRM knows, and the lists it is on.
get
/api/v1/companies/{id}Other ways to call it
CLI
troopy companies getMCP tool
troopy_get_companyRate limit120 calls in 60 seconds, for each key
Path parameters
id*stringA 24-character id
Response
200 · application/jsondata*object16 properties
id*stringA 24-character id
name*string | nulldomain*string | nullwebsite*string | nulllinkedin*string | nullindustry*string | nullsize*string | nullIts headcount as its source said it, like 11-50
location*string | nullphone*string | nullsource*objectWhere it first came from
3 properties
kind*enum<string>importappapiteammateprovider
url*string | nullat*stringISO 8601 date and time
createdBy*objectWho wrote it
3 properties
type*enum<string>personagentapi
id*stringname*stringupdatedBy*objectWho wrote it
3 properties
type*enum<string>personagentapi
id*stringname*stringcreatedAt*stringISO 8601 date and time
updatedAt*stringISO 8601 date and time
lists*array<object>The lists it is on
2 properties
id*stringA 24-character id
name*stringpeople*integerErrors
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.
404 not_foundCheck the path and any id in it. Every operation is listed in /api/v1/openapi.json.
429 rate_limitedWait the number of seconds in Retry-After, then retry.