HubSpot: Search for companies

← Companies operations · Get started

Operation hubspot.companies_search_companies

Provider route: POST /crm/objects/2026-09/companies/search. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/hubspot with npm, or alter-sdk-hubspot with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { HubSpotIntegration } from "@alter-ai/hubspot";

async function execute(input: Parameters<HubSpotIntegration["companies"]["searchCompanies"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new HubSpotIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.companies.searchCompanies(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_hubspot import HubSpotIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = HubSpotIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.companies.search_companies(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
body	Model	Required within parent	Expand Search for companies — request body — body

Referenced models: Search for companies — request body — body

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Search for companies — response body

Referenced models: Search for companies — response body

Schemas

Search for companies — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Describes a search request
after	string	Required within parent	A string representing the paging cursor token to retrieve the next set of results.
filterGroups	array	Required within parent	An array of filter groups used to filter the search results. Each filter group contains a set of filters that are applied together.
filterGroups[]	Model	Each item	Expand Search for companies — request body — body filter Groups item
limit	integer	Required within parent	An integer specifying the maximum number of results to return. Format: int32
properties	array	Required within parent	An array of strings specifying the properties to be returned in the search results.
properties[]	string	Each item
query	string	Optional	A string representing the search query to be applied.
sorts	array	Required within parent	An array of strings specifying the sorting order of the search results.
sorts[]	string	Each item

Referenced models: Search for companies — request body — body filter Groups item

Search for companies — response body

Field	Type	Presence	Description and constraints
$	object	Root	Represents a list of simple objects returned from an API request, along with the total count of objects available.
paging	Model	Optional	Expand Search for companies — response body — paging
results	array	Required within parent	An array containing the simple public objects returned in the current response.
results[]	Model	Each item	Expand Create a company — response body
total	JSON	Required within parent
total (anyOf 1)	integer	Alternative	The number of available results Format: int32
total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Search for companies — response body — paging, Create a company — response body

Search for companies — request body — body filter Groups item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a group of filters used to query data within HubSpot. This component is used to define criteria for filtering records in various API endpoints.
filters	array	Required within parent	An array of filter objects, each specifying a condition for the search query. Each filter includes properties such as propertyName, value, and operator to define the filtering logic.
filters[]	Model	Each item	Expand Search for companies — request body — body filter Groups item filters item

Referenced models: Search for companies — request body — body filter Groups item filters item

Search for companies — response body — paging

Field	Type	Presence	Description and constraints
$	object	Root	Represents the pagination information for navigating through a list of results in the API. It provides details on how to access the previous or next set of results.
next	Model	Optional	Expand Retrieve companies — response body — paging next
prev	Model	Optional	Expand Search for companies — response body — paging prev

Referenced models: Retrieve companies — response body — paging next, Search for companies — response body — paging prev

Create a company — response body

Field	Type	Presence	Description and constraints
$	object	Root	A simple public object.
archived	boolean	Required within parent	A boolean indicating whether the object is archived.
archivedAt	string	Optional	The date and time when this object was archived, in ISO 8601 format. Format: date-time
createdAt	string	Required within parent	The date and time when this object was created, in ISO 8601 format. Format: date-time
id	string	Required within parent	The unique identifier for this object, represented as a string.
objectWriteTraceId	string	Optional	A string representing the trace ID for write operations on this object.
properties	object	Required within parent	A map of property names to their values, where each value is a string. Additional keys: see wildcard field
properties.*	string	Additional keys
propertiesWithHistory	object	Optional	A map of property names to their historical values, where each value is an array of objects containing the value and timestamp. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Create a company — response body — properties With History value item
updatedAt	string	Required within parent	The date and time when this object was last updated, in ISO 8601 format. Format: date-time
url	string	Optional	A string containing the URL of the object.
warnings	array	Optional	An array of warning objects, each containing details about potential issues with the object.
warnings[]	Model	Each item	Expand Create a company — response body — warnings item

Referenced models: Create a company — response body — warnings item, Create a company — response body — properties With History value item

Search for companies — request body — body filter Groups item filters item

Field	Type	Presence	Description and constraints
$	object	Root	Defines a single condition for searching CRM objects, specifying the property to filter on, the operator to use (such as equals, greater than, or contains), and the value(s) to compare against.
highValue	string	Optional	An optional string used in range-based filters to specify the upper bound of the range.
operator	string	Required within parent	The operator used to compare the property with the value(s). It is a string and valid operators include 'EQ', 'NEQ', 'LT', 'LTE', 'GT', 'GTE', 'BETWEEN', 'IN', 'NOT_IN', 'HAS_PROPERTY', 'NOT_HAS_PROPERTY', 'CONTAINS_TOKEN', and 'NOT_CONTAINS_TOKEN'. One of: BETWEEN, CONTAINS_TOKEN, EQ, GT, GTE, HAS_PROPERTY, IN, LT, LTE, NEQ, NOT_CONTAINS_TOKEN, NOT_HAS_PROPERTY, NOT_IN
propertyName	string	Required within parent	The name of the property on which the filter is applied. It is a string that specifies the field to be filtered.
value	string	Optional	The value to be used in the filter condition. It is a string that represents the specific value to match against the property.
values	array	Optional	An array of strings used in filters that require multiple values, such as 'IN' or 'NOT_IN'.
values[]	string	Each item

Retrieve companies — response body — paging next

Field	Type	Presence	Description and constraints
$	object	Root	Specifies the paging information needed to retrieve the next set of results in a paginated API response
after	string	Required within parent	A string token used as a cursor to retrieve the next page of results.
link	string	Optional	A string URL that provides a direct link to the next page of results.

Search for companies — response body — paging prev

Field	Type	Presence	Description and constraints
$	object	Root	specifies the paging information needed to retrieve the previous set of results in a paginated API response
before	string	Required within parent	A string token that indicates the position before the current page in the paginated results.
link	string	Optional	A string URL that provides a direct link to the previous page of results.

Create a company — response body — warnings item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a warning message related to a public object in HubSpot, providing details about the nature and context of the warning.
category	string	Required within parent	A string indicating the category of the warning.
context	object	Required within parent	An object providing additional context about the warning, with string properties. Additional keys: see wildcard field
context.*	string	Additional keys
message	string	Required within parent	A string containing the warning message.

Create a company — response body — properties With History value item

Field	Type	Presence	Description and constraints
$	object	Root	Property model that includes timestamp.
sourceId	string	Optional	The identifier of the source from which the value was obtained. It is a string.
sourceLabel	string	Optional	A label providing additional context about the source. It is a string.
sourceType	string	Required within parent	The type of source from which the value was obtained. It is a string and is required.
timestamp	string	Required within parent	The date and time when the value was recorded, in ISO 8601 format. Format: date-time
updatedByUserId	JSON	Optional
updatedByUserId (anyOf 1)	integer	Alternative	The ID of the user who last updated the value. It is an integer. Format: int32
updatedByUserId (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
value	string	Required within parent	The value associated with the timestamp. It is a string.

Policy, approvals and errors

SDK function policy ID: hubspot.companies_search_companies. Catalog operation: companies_search_companies. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["crm.objects.companies.read"]

Official provider source