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

MethodPathDescription
GET/companiesList companies
GET/companies/:idGet a company
POST/companiesCreate a company
PATCH/companies/:idUpdate a company
DELETE/companies/:idDelete a company
POST/companies + X-Service-Method: searchSearch 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

FieldTypeDescription
idintegerRead-only. Unique ID.
namestringCompany name. Required on create.
organization_idintegerOrganization that owns the company. Required on create.
created_by_user_idinteger | nullRead-only. User who created the company (the API key's user).
owned_by_user_idinteger | nullUser who owns the company. Defaults to the API key's user.
custom_fields_by_keyobjectCustom field values keyed by the field key (see Custom fields, entity_type=company). This is the field you write.
custom_fields_by_nameobjectRead-only. Same values keyed by the field name.
custom_fields_meta_dataarrayRead-only. One entry per value: custom_field_id, custom_field_key, custom_field_name, custom_field_value.
tagsarrayTags as { id, name, color } objects. Default [].
created_atstring (date-time)Read-only. Creation time.
updated_atstring (date-time)Read-only. Last update time.
deleted_atstring (date-time) | nullRead-only. Set when the company is deleted.

Related

Report an issue with this documentation

Please log in to report issues with our documentation.