Companies

Companies Endpoint Reference

Companies represent the organization to which lead records belong. Leads are added to a
Company by populating their corresponding externalCompanyId field. Leads linked to a company record will directly inherit the values from a company record as though the values existed on the lead’s own record.

Company APIs are only exposed for subscriptions which do not have a native CRM sync enabled.

.

Describe

Describing the company object will give you all the information you need to interact with them.

Query

The pattern for querying companies closely follows that of the leads API with the added restriction that the filterType parameter accepts the fields listed in the searchableFields array of the Describe Companies call, or dedupeFields.

filterType and filterValues are required query parameters.  fields, nextPageToken, and batchSize are optional parameters.  The parameters function just like the corresponding parameters in the Leads and Opportunities APIs.

If the fields parameter is omitted, the default set of fields returned is:

  • id
  • dedupeFields
  • updatedAt
  • createdAt

Create and Update

Just like opportunities, there are three modes for creating and updating companies: createOnly, updateOnly, and createOrUpdate.  Modes are specified in the action parameter of the request.  Both the dedupeBy and action parameters are optional, and default to the dedupeFields and the createOrUpdate modes respectively.

Delete

The deletion criteria is specified in the input array, which contains a list of search values.  The deletion method is specified in the deleteBy parameter.  Permissible values are: dedupeFields, idField.  Default is dedupeFields.