HubSpot Search
CertifiedSearch HubSpot company records
HubSpot Search
Search HubSpot company records
Runs HubSpot CRM search on companies with optional query, filters, sorts, and property selection. Default limit is 10; set fetchAllPages to true to page through all results.
type: io.kestra.plugin.hubspot.companies.SearchExamples
id: hubspot_companies_search
namespace: company.team
tasks:
- id: search_companies
type: io.kestra.plugin.hubspot.companies.Search
apiKey: "{{ secret('HUBSPOT_API_KEY') }}"
properties:
- name
- domain
- industry
limit: 10
sorts:
- propertyName: "createdate"
direction: "DESCENDING"
Properties
after string
Pagination token for fetching the next page of results
apiKey string
HubSpot API key
fetchAllPages booleanstring
falseWhether to fetch all records by paging through results
If true, iterates pages until exhausted. Default is false; set to true to retrieve the full result set.
filterGroups array
Filter groups for the search query
limit integerstring
10Maximum number of results to return
Default is 10; maximum allowed by HubSpot is 100.
oauthToken string
HubSpot OAuth token
options Non-dynamic
The HTTP client configuration
io.kestra.core.http.client.configurations.HttpConfiguration
falseIf true, allow a failed response code (response code >= 400)
List of response code allowed for this request
The authentication to use.
io.kestra.core.http.client.configurations.BasicAuthConfiguration
The password for HTTP basic authentication.
The username for HTTP basic authentication.
io.kestra.core.http.client.configurations.BearerAuthConfiguration
The token for bearer token authentication.
io.kestra.core.http.client.configurations.DigestAuthConfiguration
The password for HTTP Digest authentication.
The username for HTTP Digest authentication.
The password for HTTP basic authentication. Deprecated, use auth property with a BasicAuthConfiguration instance instead.
The username for HTTP basic authentication. Deprecated, use auth property with a BasicAuthConfiguration instance instead.
durationThe time allowed to establish a connection to the server before failing.
durationThe time an idle connection can remain in the client's connection pool before being closed.
UTF-8The default charset for the request.
java.nio.charset.Charset
trueWhether to enable TCP Keep-Alive extended socket options (TCP_KEEPIDLE, TCP_KEEPINTERVAL, TCP_KEEPCOUNT).
Set to false when running on Windows workers, as these extended socket options are not supported by the Windows JDK and will cause connection failures.
trueWhether redirects should be followed automatically.
ALLTRACEDEBUGINFOWARNERROROFFNOT_SPECIFIEDThe log level for the HTTP client.
REQUEST_HEADERSREQUEST_BODYRESPONSE_HEADERSRESPONSE_BODYThe enabled log.
The maximum content length of the response.
The proxy configuration.
io.kestra.core.http.client.configurations.ProxyConfiguration
The address of the proxy server.
The password for proxy authentication.
The port of the proxy server.
DIRECTDIRECTHTTPSOCKSThe type of proxy to use.
The username for proxy authentication.
The address of the proxy server.
The password for proxy authentication.
The port of the proxy server.
DIRECTHTTPSOCKSThe type of proxy to use.
The username for proxy authentication.
durationThe time allowed for a read connection to remain idle before closing it.
durationThe maximum time allowed for reading data from the server before failing.
The SSL request options
io.kestra.core.http.client.configurations.SslOptions
Whether to disable checking of the remote SSL certificate.
Only applies if no trust store is configured. Note: This makes the SSL connection insecure and should only be used for testing. If you are using a self-signed certificate, set up a trust store instead.
The timeout configuration.
io.kestra.core.http.client.configurations.TimeoutConfiguration
The time allowed to establish a connection to the server before failing.
PT5MThe time allowed for a read connection to remain idle before closing it.
pluginDefaultsRef Non-dynamicstring
Reference (ref) of the pluginDefaults to apply to this task.
properties array
Specific properties to include in the response
Optional list of property names. Leave empty to return all properties.
query string
Search default text properties
Full-text query across default text properties for the target object. See HubSpot search docs for query semantics.
sorts array
Sort options for the results
Outputs
total integer
Total number of records fetched
uri string
uriURI of stored results
Internal storage URI containing the aggregated search results.
