HubSpot: Search for contracts using specified criteria

← Contracts operations · Get started

Operation hubspot.contracts_search

Provider route: POST /crm/objects/2026-09/contracts/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["contracts"]["search"]>[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.contracts.search(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.contracts.search(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 contracts using specified criteria — request body — body

Referenced models: Search for contracts using specified criteria — 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 contracts using specified criteria — response body

Referenced models: Search for contracts using specified criteria — response body

Schemas

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

Search for contracts using specified criteria — 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. This is used to fetch the next set of results in a paginated response.
filterGroups	array	Required within parent	An array of filter groups used to narrow down the search results. Each filter group can contain multiple filters that define specific criteria.
filterGroups[]	Model	Each item	Expand Search for contracts using specified criteria — request body — body filter Groups item
limit	integer	Required within parent	An integer specifying the maximum number of results to return. This helps control the size of the result set. Format: int32
properties	array	Required within parent	An array of strings indicating which properties of the CRM objects should be returned in the search results.
properties[]	string	Each item
query	string	Optional	A string used to perform a full-text search across the CRM objects.
sorts	array	Required within parent	An array of strings specifying the sort order of the search results. Each string represents a property to sort by, optionally prefixed with a '-' to indicate descending order.
sorts[]	string	Each item

Referenced models: Search for contracts using specified criteria — request body — body filter Groups item

Search for contracts using specified criteria — 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 contracts using specified criteria — 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 Search for contracts using specified criteria — response body — results item
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 contracts using specified criteria — response body — paging, Search for contracts using specified criteria — response body — results item

Search for contracts using specified criteria — 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 search results. Each filter specifies a property, an operator, and a value or range of values to match.
filters[]	Model	Each item	Expand Search for contracts using specified criteria — request body — body filter Groups item filters item

Referenced models: Search for contracts using specified criteria — request body — body filter Groups item filters item

Search for contracts using specified criteria — 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 List — contracts get Contracts — response body — paging next
prev	Model	Optional	Expand Search for contracts using specified criteria — response body — paging prev

Referenced models: List — contracts get Contracts — response body — paging next, Search for contracts using specified criteria — response body — paging prev

Search for contracts using specified criteria — response body — results item

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 on this object.
properties	object	Required within parent	A map of property names to their values, where each property is represented as 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 Read — contracts get Contract — 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 representing the URL of this object.
warnings	array	Optional	An array of warnings related to this object, where each warning contains a category, message, and context.
warnings[]	Model	Each item	Expand Read — contracts get Contract — response body — warnings item

Referenced models: Read — contracts get Contract — response body — warnings item, Read — contracts get Contract — response body — properties With History value item

Search for contracts using specified criteria — 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	A string representing the upper bound value for range-based filter operations. It is used with operators like 'BETWEEN'.
operator	string	Required within parent	The operator defines the type of comparison to be made between the property and 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 identifies the specific field in the CRM object.
value	string	Optional	A string representing the value to be used in the filter operation. This is used in conjunction with the operator to determine matching records.
values	array	Optional	An array of strings representing multiple values for the filter operation. This is used with operators like 'IN' and 'NOT_IN' to match any of the specified values.
values[]	string	Each item

List — contracts get Contracts — 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 in the current page of results. This token is used to fetch the next page.
link	string	Optional	A URL string that provides a direct link to the next page of results.

Search for contracts using specified criteria — 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 as a cursor to identify the position before the current page of results. This token can be used to fetch the previous page.
link	string	Optional	A string representing the URL link to the previous page of results. This provides a direct way to access the previous set of resources.

Read — contracts get Contract — 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 containing additional context about 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.contracts_search. Catalog operation: contracts_search. 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.contracts.read"]

Official provider source