Search
Searches for HubSpot companies based on filter criteria.
type: "io.kestra.plugin.hubspot.companies.Search"Examples
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
afterstring
Pagination token for fetching the next page of results
apiKeystring
HubSpot API key
fetchAllPagesbooleanstring
falseWhether to fetch all records by paging through results
If true, continues fetching all pages until no more results. Default is true.
filterGroupsarray
Filter groups for the search query
limitintegerstring
10Maximum number of results to return
Default is 10, maximum is 100
oauthTokenstring
HubSpot OAuth token
optionsNon-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 authentification 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.
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.
durationdurationThe 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 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
DIRECTDIRECTHTTPSOCKSThe 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.
durationdurationThe 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
durationThe time allowed to establish a connection to the server before failing.
PT5MdurationThe time allowed for a read connection to remain idle before closing it.
propertiesarray
Specific properties to include in the response
Leave empty to get all properties
querystring
Search all default text properties in records of the specified object.
To learn more, check out the HubSpot API documentation.
sortsarray
Sort options for the results
Outputs
totalinteger
Total number of records fetched
uristring
uriURI of the file