HubSpot Contact Search Block | Scout

The HubSpot Contact Search block enables users to search for contacts within their HubSpot CRM using customizable filters. This block integrates directly with HubSpot’s API, enabling dynamic and efficient contact retrieval based on user-defined criteria.

Configuration (Required)

HubSpot Access Token

stringRequired

Use Environment Variables to safely and securely access sensitive credentials in a Scout workflow.

Access token for authenticating with the HubSpot API. Ensure that the token is valid and kept secure to maintain access to the API. This field supports Jinja templating for dynamic token insertion.

Filters (JSON format)

codeRequired

JSON formatted string that specifies the filter criteria for searching contacts. Carefully construct the filters in valid JSON format to accurately query the desired contacts. This field supports Jinja templating for dynamic filter construction.

Limit

integer

The maximum number of contacts to return. The default value is 10. Adjust this parameter to control the number of results returned, balancing between performance and data retrieval needs.

See Workflow Logic & State > State Management for details on using dynamic variables in this block.

Outputs

The block outputs a dictionary containing the search results from HubSpot, formatted as JSON. This structured output allows for further processing and integration within the workflow.

Usage Context

Use this block to retrieve specific contacts from HubSpot based on complex filter criteria. Ensure that the filters are correctly formatted in JSON to avoid errors.

Best Practices

Ensure that the HubSpot Access Token is kept secure and is valid for API requests.
Carefully construct the filters in valid JSON format to accurately query the desired contacts.
Adjust the limit parameter to control the number of results returned, balancing between performance and data retrieval needs.