HubSpot: Search for contacts

← Contacts operations · Get started

Operation hubspot.contacts_search_contacts

Provider route: POST /crm/objects/2026-09/contacts/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["contacts"]["searchContacts"]>[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.contacts.searchContacts(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.contacts.search_contacts(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 contacts — request body — body

Referenced models: Search for contacts — 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 contacts — response body

Referenced models: Search for contacts — response body

Schemas

1 more schema is linked from the tables above, on the schema pages.

Search for contacts — 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 results after a specific point in the result set.
filterGroups	array	Required within parent	An array of filter groups used to narrow down the search results. Each filter group contains a set of filters that are applied together.
filterGroups[]	Model	Each item	Expand Search for contacts — request body — body filter Groups item
limit	integer	Required within parent	An integer indicating the maximum number of results to return. Format: int32
properties	array	Required within parent	An array of strings specifying which properties of the objects should be included in the search results.
properties[]	string	Each item
query	string	Optional	A string representing the search query to be applied to the objects.
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 contacts — request body — body filter Groups item

Search for contacts — 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 contacts — response body — paging
results	array	Required within parent	An array of SimplePublicObject items, each representing an individual public object.
results[]	Model	Each item	Expand Create a contact — 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 contacts — response body — paging, Create a contact — response body

Search for contacts — 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 that define the criteria for the search. Each filter specifies a property, an operator, and a value to match against.
filters[]	Model	Each item	Expand Search for contacts — request body — body filter Groups item filters item

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

Search for contacts — 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 contacts — response body — paging next
prev	Model	Optional	Expand Search for contacts — response body — paging prev

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

Create a contact — response body

Field	Type	Presence	Description and constraints
$	object	Root	A simple public object.
archived	boolean	Required within parent	A boolean indicating whether this 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 related to 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, each represented as an array of ValueWithTimestamp objects. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Create a contact — 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 this object.
warnings	array	Optional	An array of PublicObjectWarning objects, each containing warnings related to this object.
warnings[]	Model	Each item	Expand Create a contact — response body — warnings item

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

Search for contacts — 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 representing the upper bound of a range filter, used when the operator is 'BETWEEN'.
operator	string	Required within parent	The operator used to compare the property value. It is a string and valid values 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 to filter on. It is a string that specifies which object property the filter applies to.
value	string	Optional	The value to compare against the specified property. It is a string used in conjunction with the operator to determine matching results.
values	array	Optional	An array of strings representing multiple values to compare against the specified property, used with operators like 'IN' or 'NOT_IN'.
values[]	string	Each item

Retrieve contacts — 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 that indicates the position after the last item on the current page. This token is used to fetch the next set of results.
link	string	Optional	A string URL that provides a direct link to the next page of results.

Search for contacts — 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 used to identify the position before the current page in a paginated list.
link	string	Optional	A string URL that provides a direct link to the previous page of results.

Create a contact — 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 representing the category of the warning.
context	object	Required within parent	An object providing additional context for the warning, with string values for each context key. Additional keys: see wildcard field
context.*	string	Additional keys
message	string	Required within parent	A string containing the warning message.

Policy, approvals and errors

SDK function policy ID: hubspot.contacts_search_contacts. Catalog operation: contacts_search_contacts. 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.contacts.read"]

Official provider source