HubSpot: Search for deals using various filters and criteria to retrieve specific records

← Deals operations · Get started

Operation hubspot.deals_search_deals

Provider route: POST /crm/objects/2026-09/0-3/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["deals"]["searchDeals"]>[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.deals.searchDeals(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.deals.search_deals(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 deals using various filters and criteria to retrieve specific records — request body — body

Referenced models: Search for deals using various filters and criteria to retrieve specific records — 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 deals using various filters and criteria to retrieve specific records — response body

Referenced models: Search for deals using various filters and criteria to retrieve specific records — response body

Schemas

Search for deals using various filters and criteria to retrieve specific records — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Describes a search request
after	string	Required within parent	A paging cursor token for retrieving subsequent pages.
filterGroups	array	Required within parent	Up to 6 groups of filters defining additional query criteria.
filterGroups[]	Model	Each item	Expand Search for deals using various filters and criteria to retrieve specific records — request body — body filter Groups item
limit	integer	Required within parent	The maximum results to return, up to 200 objects. Format: int32
properties	array	Required within parent	A list of property names to include in the response.
properties[]	string	Each item
query	string	Optional	The search query string, up to 3000 characters.
sorts	array	Required within parent	Specifies sorting order based on object properties.
sorts[]	string	Each item

Referenced models: Search for deals using various filters and criteria to retrieve specific records — request body — body filter Groups item

Search for deals using various filters and criteria to retrieve specific records — 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 Return all draft tables — response body — paging
results	array	Required within parent	An array of SimplePublicObject items, each representing a CRM object with its basic properties.
results[]	Model	Each item	Expand Create — deals create Deal — 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: Return all draft tables — response body — paging, Create — deals create Deal — response body

Search for deals using various filters and criteria to retrieve specific records — 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 filtering. Each filter specifies conditions such as property name, value, and operator.
filters[]	Model	Each item	Expand Search for deals using various filters and criteria to retrieve specific records — request body — body filter Groups item filters item

Referenced models: Search for deals using various filters and criteria to retrieve specific records — request body — body filter Groups item filters item

Return all draft tables — 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 Get all tax rates — response body — paging next
prev	Model	Optional	Expand Return all draft tables — response body — paging prev

Referenced models: Get all tax rates — response body — paging next, Return all draft tables — response body — paging prev

Create — deals create Deal — response body

Field	Type	Presence	Description and constraints
$	object	Root	A simple public object.
archived	boolean	Required within parent	Whether the object is archived.
archivedAt	string	Optional	The timestamp when the object was archived, in ISO 8601 format. Format: date-time
createdAt	string	Required within parent	The timestamp when the object was created, in ISO 8601 format. Format: date-time
id	string	Required within parent	The unique ID of the object.
objectWriteTraceId	string	Optional	An identifier used for tracing the creation or update request of the object.
properties	object	Required within parent	Key-value pairs representing the properties of the object. Additional keys: see wildcard field
properties.*	string	Additional keys
propertiesWithHistory	object	Optional	Key-value pairs representing the properties of the object along with their history. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Read — deals get Deal — response body — properties With History value item
updatedAt	string	Required within parent	The timestamp when the object was last updated, in ISO 8601 format. Format: date-time
url	string	Optional	A string representing the URL for this object.
warnings	array	Optional	An array of warnings related to this object, each containing a category, message, and context.
warnings[]	Model	Each item	Expand Read — deals get Deal — response body — warnings item

Referenced models: Read — deals get Deal — response body — warnings item, Read — deals get Deal — response body — properties With History value item

Search for deals using various filters and criteria to retrieve specific records — 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	The upper boundary value when using ranged-based filters.
operator	string	Required within parent	The operator that defines the type of comparison to be made. 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 apply the filter to.
value	string	Optional	The value to match against the property.
values	array	Optional	The values to match against the property.
values[]	string	Each item

Get all tax rates — 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 paging cursor token for retrieving subsequent pages.
link	string	Optional	A URL that can be used to retrieve the next page results.

Return all draft tables — 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 paging cursor token for retrieving previous pages.
link	string	Optional	A URL that can be used to retrieve the previous pages' results.

Read — deals get Deal — 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 about the warning, with keys and values as strings. Additional keys: see wildcard field
context.*	string	Additional keys
message	string	Required within parent	A string containing the warning message.

Read — deals get Deal — response body — properties With History value item

Field	Type	Presence	Description and constraints
$	object	Root	Property model that includes timestamp.
sourceId	string	Optional	The unique ID of the property.
sourceLabel	string	Optional	A human-readable label.
sourceType	string	Required within parent	The property type.
timestamp	string	Required within parent	The timestamp when the property was updated, in ISO 8601 format. Format: date-time
updatedByUserId	JSON	Optional
updatedByUserId (anyOf 1)	integer	Alternative	The ID of the user who last updated the property. Format: int32
updatedByUserId (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
value	string	Required within parent	The property value.

Policy, approvals and errors

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

Official provider source