Hanzo
OpenapiCrm

Returns one of the caller org's companies.

Returns one of the caller org's companies.

GET /v1/crm/companies/{id}

Addresshttps://api.hanzo.ai/v1/crm/companies/{id}
MethodGET
Operationget_crm_companies_by_id
AuthAuthorization: Bearer $HANZO_API_KEY

Returns one of the caller org's companies. An id belonging to another org reads as not found.

Request

1 field.

FieldInTypeRequiredDescription
idpathstringyesID is the record to act on, from the path.

Response

StatusBodyMeaning
200Companyok

200 body — 13 fields.

FieldInTypeAlwaysDescription
arrbodyintegerARR is annual recurring revenue in minor units (cents) of Currency.
citybodystringCity is the head-office city.
countrybodystringCountry is the head-office country.
createdAtbodyintegerCreatedAt is the unix second the company was created.
currencybodystringCurrency is the ISO code ARR is denominated in; a write that names none stores USD.
domainNamebodystringDomainName is the company's primary domain, e.g.
employeesbodyintegerEmployees is the headcount.
idbodystringID is the server-minted company id ("comp_" + 128 random bits).
idealCustomerProfilebodybooleanICP marks the company as an ideal-customer-profile fit.
linkedinLinkbodystringLinkedin is the company's LinkedIn URL.
namebodystringName is the company name.
updatedAtbodyintegerUpdatedAt is the unix second of the last write.
xLinkbodystringXLink is the company's X (Twitter) URL.

Failure carries the platform error shape — see Errors.

Examples

hanzo crm companies get <id>

CRM API · All Hanzo APIs · Interactive reference

How is this guide?

On this page