Skip to main content
Companies represent organizations in your CRM — typically the employers, customers, or accounts that your contacts belong to. Each company is owned by a specific agent (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
array
Array of { email, is_primary } objects.
array
Array of { phone_number, is_primary } objects.
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/companies
Paginated list of companies in the workspace.

Query parameters

Example


Get a company

GET
GET /api/v1/companies/{id}

Example


Create a company

POST
POST /api/v1/companies
Requires a key with the write scope.

Body fields

Example


Update a company

PATCH
PATCH /api/v1/companies/{id}
Same fields as Create a company. bot_id cannot be changed.

Example


Delete a company

DELETE
DELETE /api/v1/companies/{id}
Returns 204 No Content with an empty body on success.

Example

Deletion is permanent. Contacts that referenced this company will have their company_id cleared but will not themselves be deleted.