This endpoint is used to get all of the companies in a HubSpot account. Use case for this endpoint: This endpoint is useful when you’re installing a new application and need to sync company data from HubSpot. For example, if you install an app that integrates HubSpot with an Enterprise Resource Planning app (ERP), that app may want to get all the company records stored in the CRM. It could then match them to customer records stored in the ERP and use webhooks to get incremental updates.
The number of records to return. Defaults to 100, has a maximum value of 250.
Used to page through the results. If there are more records in your portal than the limit= parameter, you will need to use the offset returned in the first request to get the next set of results.
May be included multiple times. Used to include specific company properties in the results. By default, the results will only include the company ID, and will not include the values for any properties for your companies. Including this parameter will include the data for the specified property in the results. You can include this parameter multiple times to request multiple properties.Note: Companies that do not have a value set for a property will not include that property, even when you specify the property. A company without a value for the website property would not show the website property in the results, even with &properties=website in the URL.
May be included multiple times. Works similarly to properties=
, but this parameter will include the history for the specified property, instead of just including the current value. Use this parameter when you need the full history of changes to a property's value.
Returns any merge history if a company has been previously merged with another company record. Defaults to false.
Successful response - This endpoint is used to get all of the companies in a HubSpot account
The response is of type object
.