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
Section titled “The Company Object”| Field | Type | Description |
|---|---|---|
id | uuid | |
account_id | uuid | |
created_by | uuid | |
name | string | |
domain | string | |
industry | string | |
notes | string | |
phone | string | |
website | string | |
linkedin_url | string | |
address | string | |
city | string | |
state | string | |
zip_code | string | |
country | string | |
employee_count | int? | |
annual_revenue | int? | |
tags | string[] | |
custom_fields | object | |
created_at | datetime | |
updated_at | datetime |
Create a new company
Section titled “Create a new company”Endpoint: companies-create
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | |
domain | string | No | |
industry | string | No | |
notes | string | No | |
phone | string | No | |
website | string | No | |
linkedin_url | string | No | |
address | string | No | |
city | string | No | |
state | string | No | |
zip_code | string | No | |
country | string | No | |
employee_count | int? | No | |
annual_revenue | int? | No | |
tags | string[] | No | |
custom_fields | object? | No |
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
Section titled “Delete a company”Endpoint: companies-delete
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes |
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
Section titled “Get a company by ID”Endpoint: companies-get
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes |
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
Section titled “List companies with filtering and pagination”Endpoint: companies-list
| Field | Type | Required | Description |
|---|---|---|---|
search | string | No | |
tags | string[] | No | |
cursor | string | No | |
limit | int | No |
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
Section titled “Update an existing company”Endpoint: companies-update
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
name | string? | No | |
domain | string? | No | |
industry | string? | No | |
notes | string? | No | |
phone | string? | No | |
website | string? | No | |
linkedin_url | string? | No | |
address | string? | No | |
city | string? | No | |
state | string? | No | |
zip_code | string? | No | |
country | string? | No | |
employee_count | int? | No | |
annual_revenue | int? | No | |
tags | string[] | No | |
custom_fields | object? | No |
curl -X POST https://api.driftwoodapp.com/api/companies-update \ -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{"id": "..."}'