HubSpot: Get customers from HubSpot

The name or label of the company property in HubSpot that holds the e-mail address of the company. Default: company_email. APIcenter uses this e-mail address to recognize a company and to identify the customer in the activities. If the property does not exist in HubSpot, the flow stops with an error message, unless Create missing properties in the target system is on: then APIcenter creates the property. This field is required. When sending, the e-mail address in the data mapping must go to the same property.

The lifecycle stage for companies, as the name or ID of the stage in HubSpot (uppercase and lowercase letters do not matter). Default: customer. For Send Customer and Send Sales Order, the companies that APIcenter sends get this stage; this is required, unless you only process contacts. For Get Customer and Get Sales Order, APIcenter updates the companies it got to this stage after getting them; if you leave the field empty, nothing is updated. According to HubSpot, the standard tools can only move the lifecycle stage forward; for an earlier stage, the value must be cleared first. Test this with an example.

The lifecycle stage for contacts, as the name or ID of the stage in HubSpot (uppercase and lowercase letters do not matter). Default: customer. For Send Customer and Send Sales Order, the contacts that APIcenter sends get this stage; this is required. For Get Customer and Get Sales Order, APIcenter updates the contacts it got to this stage after getting them; if you leave the field empty, nothing is updated. According to HubSpot, the standard tools can only move the lifecycle stage forward; for an earlier stage, the value must be cleared first. Test this with an example.

The pipeline for companies. Enter the name or ID of the pipeline in HubSpot; uppercase and lowercase letters do not matter. Default: companies-lifecycle-pipeline. For Send Customer and Send Sales Order, APIcenter sets this pipeline and the lifecycle stage for companies on the companies that it sends. This is required, unless you only process contacts (Only process contact information). For Get Customer and Get Sales Order, APIcenter updates the companies it got to this pipeline and stage after getting them; if you leave the fields empty, nothing is updated. Always fill in the pipeline and the stage together.

The pipeline for contacts. Enter the name or ID of the pipeline in HubSpot; uppercase and lowercase letters do not matter. Default: contacts-lifecycle-pipeline. For Send Customer and Send Sales Order, APIcenter sets this pipeline and the lifecycle stage for contacts on the contacts that it sends. For Get Customer and Get Sales Order, APIcenter updates the contacts it got to this pipeline and stage after getting them; if you leave the fields empty, nothing is updated. Always fill in the pipeline and the stage together.

The pipeline that APIcenter filters on when getting data. Enter the name or ID of the pipeline in HubSpot; uppercase and lowercase letters do not matter. For Get Customer, APIcenter filters contacts on this pipeline; the default is contacts-lifecycle-pipeline, the lifecycle pipeline of contacts. For Get Sales Order, APIcenter only gets deals that are in this pipeline. If the pipeline or a stage cannot be found in HubSpot, the flow stops with an error message. This setting is required.

The lifecycle stage that APIcenter filters on when getting customers. Only contacts in this stage are retrieved. Enter the name or ID of the stage in HubSpot; uppercase and lowercase letters do not matter. Default: customer. This setting is required. If you want to get contacts in another stage, change this setting.

Turns on URL encoding for values that APIcenter puts in the URL of a request to HubSpot. This prevents errors with special characters such as spaces, slashes or ampersands. In HubSpot, search values such as an e-mail address, SKU or deal name are in the content of the request and not in the URL; the URL only contains IDs and object types. So you rarely need this. This is the main switch: values are only encoded if you also turn on Enable URL Encoding of data in the endpoints of the source application (when getting) or Enable URL Encoding of data in the endpoints of the target application (when sending). Default: off.

This setting has no effect for HubSpot. The data that APIcenter exchanges with HubSpot has no administration field, so there is nothing to map. Leave this setting off (default).

This setting has no effect for HubSpot, because the data that APIcenter exchanges with HubSpot has no administration field. Leave it as it is.

The maximum number of contacts, products or deals that APIcenter gets from HubSpot in each run. The default value is 10; you can choose a number from 1 up to and including 15. APIcenter gets the oldest changed records first. With a higher number, you clear a backlog faster, but each run takes longer.

The date and time from which APIcenter gets contacts (Get Customer) or products (Get Product) from HubSpot. APIcenter only gets records that changed after this moment, the oldest change first. After each run, APIcenter sets the date to the modification date of the last record it got, so normally you do not need to change it. If you set the date back in time, APIcenter gets those records again and passes them on again. Default: 2025-01-01T00:00:00.

In practice, this setting has no effect for HubSpot. The HubSpot flows ask for one list per run with their own limit (when getting data, this is Amount to process) and do not read extra pages. The default value is 20; you do not need to change it.

This setting has no effect for HubSpot. Get Customer keeps track of where the flow stopped with the date from which contacts are retrieved, not with an offset. The default value is 0; you do not need to change it.

In practice, this setting has no effect for HubSpot. The HubSpot flows decide themselves how many records they ask for per request: when getting data, this is Amount to process. The default value is 50; you do not need to change it.