bot_id) and inherits the workspace from your API key.
The Company object
string
Unique company identifier.
string
string
The agent that owns this company.
string
Company name.
string | null
Primary domain (e.g.
acme.com).string | null
string | null
string | null
Free-form size band (e.g.
"50-200").string | null
number | null
number | null
string | null
string[]
Plain email strings, lowercased. The first item is the primary email.
string[]
Plain phone strings in E.164 format. The first item is the primary number.
string[]
number | null
Sum of
deal_value across all contacts linked to this company.string | null
string | null
string | null
string | null
string | null
string | null
string | null
string | null
string | null
object
string | null
ISO 8601 timestamp of the most recent activity on a related contact.
string
ISO 8601 timestamp.
string
ISO 8601 timestamp.
List companies
GET
GET /api/v1/companiesQuery parameters
Example
Get a company
GET
GET /api/v1/companies/{id}Example
Create a company
POST
POST /api/v1/companieswrite scope.
Body fields
emails and phone_numbers are arrays of plain strings. For compatibility with older integrations the API also accepts { "email": "...", "is_primary": true } and { "phone_number": "...", "is_primary": true } objects; they are converted to strings on save, and any item flagged is_primary is moved to the front. Responses always return plain strings.Example
Update a company
PATCH
PATCH /api/v1/companies/{id}bot_id cannot be changed.
Example
Delete a company
DELETE
DELETE /api/v1/companies/{id}204 No Content with an empty body on success.

