Companies

Companies represent the organizations your team works with. Link contacts to companies, track key details, and see the full picture of every business relationship.

The Company Object

Field	Type	Description
id	uuid	Unique identifier of the company (UUID).
account_id	uuid	ID of the account that owns this company (UUID).
created_by	uuid	ID of the user who created this company (UUID).
name	string	Company name.
domain	string	Primary domain of the company (e.g. example.com).
industry	string	Industry the company operates in (free-form text).
notes	string	Free-form notes about the company.
phone	string	Company phone number.
website	string	Company website URL.
linkedin_url	string	Company LinkedIn profile URL.
address	string	Street address.
city	string	City.
state	string	State or province.
zip_code	string	Postal or ZIP code.
country	string	Country.
employee_count	int?	Number of employees, or null if unknown.
annual_revenue	int?	Annual revenue in integer cents, or null if unknown.
tags	string[]	Tags associated with the company; normalized to lowercase, trimmed, and deduplicated.
custom_fields	object	Custom field values as a JSON object, validated against the account’s company custom field definitions.
created_at	datetime	Timestamp when the company was created (ISO 8601).
updated_at	datetime	Timestamp when the company was last updated (ISO 8601).

Create a new company

Endpoint: companies-create

Field	Type	Required	Description
name	string	Yes	Company name.
domain	string	No	Primary domain of the company (e.g. example.com).
industry	string	No	Industry the company operates in (free-form text).
notes	string	No	Free-form notes about the company.
phone	string	No	Company phone number.
website	string	No	Company website URL.
linkedin_url	string	No	Company LinkedIn profile URL.
address	string	No	Street address.
city	string	No	City.
state	string	No	State or province.
zip_code	string	No	Postal or ZIP code.
country	string	No	Country.
employee_count	int?	No	Number of employees.
annual_revenue	int?	No	Annual revenue in integer cents.
tags	string[]	No	Tags to assign; normalized to lowercase, trimmed, and deduplicated.
custom_fields	object?	No	Custom field values as a JSON object, validated against the account’s company custom field definitions.

curl -X POST https://api.driftwoodapp.com/api/companies-create \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name": "..."}'

Delete a company

Endpoint: companies-delete

Field	Type	Required	Description
id	string	Yes	ID of the company to delete (UUID).

curl -X POST https://api.driftwoodapp.com/api/companies-delete \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"id": "..."}'

Get a company by ID

Endpoint: companies-get

Field	Type	Required	Description
id	string	Yes	ID of the company to retrieve (UUID).

curl -X POST https://api.driftwoodapp.com/api/companies-get \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"id": "..."}'

List companies with filtering and pagination

Endpoint: companies-list

Field	Type	Required	Description
search	string	No	Full-text search query matched against company fields.
tags	string[]	No	Filter to companies that have all of these tags; normalized to lowercase, trimmed, and deduplicated.
cursor	string	No	Opaque pagination cursor from a previous response’s next_cursor.
limit	int	No	Maximum number of companies to return per page.

curl -X POST https://api.driftwoodapp.com/api/companies-list \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

Update an existing company

Endpoint: companies-update

Field	Type	Required	Description
id	string	Yes	ID of the company to update (UUID). Required.
name	string?	No	New company name. Omit to leave unchanged.
domain	string?	No	New primary domain. Omit to leave unchanged.
industry	string?	No	New industry (free-form text). Omit to leave unchanged.
notes	string?	No	New notes. Omit to leave unchanged.
phone	string?	No	New phone number. Omit to leave unchanged.
website	string?	No	New website URL. Omit to leave unchanged.
linkedin_url	string?	No	New LinkedIn profile URL. Omit to leave unchanged.
address	string?	No	New street address. Omit to leave unchanged.
city	string?	No	New city. Omit to leave unchanged.
state	string?	No	New state or province. Omit to leave unchanged.
zip_code	string?	No	New postal or ZIP code. Omit to leave unchanged.
country	string?	No	New country. Omit to leave unchanged.
employee_count	int?	No	New employee count. Omit to leave unchanged.
annual_revenue	int?	No	New annual revenue in integer cents. Omit to leave unchanged.
tags	string[]	No	Replacement set of tags; normalized to lowercase, trimmed, and deduplicated. Omit to leave unchanged.
custom_fields	object?	No	Custom field values to merge onto existing values, validated against the account’s company custom field definitions. Omit to leave unchanged.

curl -X POST https://api.driftwoodapp.com/api/companies-update \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"id": "..."}'

Error Codes

Code	Description
companies.invalid_request	invalid request body
companies.invalid_custom_fields	custom field validation failed
companies.invalid_id	invalid company ID
companies.not_found	company not found