Companies
A company is an account or business your contacts and deals belong to. Use this resource to keep company records in sync, link contacts and deals to them, and store custom fields and tags.
Endpoints
| Method | Path | Description |
|---|---|---|
GET | /companies | List companies |
GET | /companies/:id | Get a company |
POST | /companies | Create a company |
PATCH | /companies/:id | Update a company |
DELETE | /companies/:id | Delete a company |
POST | /companies + X-Service-Method: search | Search companies |
Reads are limited to your API key's organization. Pass organization_id as a filter to work with one organization.
The company object
json
Fields
| Field | Type | Description |
|---|---|---|
id | integer | Read-only. Unique ID. |
name | string | Company name. Required on create. |
organization_id | integer | Organization that owns the company. Required on create. |
created_by_user_id | integer | null | Read-only. User who created the company (the API key's user). |
owned_by_user_id | integer | null | User who owns the company. Defaults to the API key's user. |
custom_fields_by_key | object | Custom field values keyed by the field key (see Custom fields, entity_type=company). This is the field you write. |
custom_fields_by_name | object | Read-only. Same values keyed by the field name. |
custom_fields_meta_data | array | Read-only. One entry per value: custom_field_id, custom_field_key, custom_field_name, custom_field_value. |
tags | array | Tags as { id, name, color } objects. Default []. |
created_at | string (date-time) | Read-only. Creation time. |
updated_at | string (date-time) | Read-only. Last update time. |
deleted_at | string (date-time) | null | Read-only. Set when the company is deleted. |
Related
Report an issue with this documentation
Please log in to report issues with our documentation.