HubSpot: Search — orders search Orders

← Orders operations · Get started

Operation hubspot.orders_search_orders

Provider route: POST /crm/objects/2026-09/orders/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["orders"]["searchOrders"]>[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.orders.searchOrders(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.orders.search_orders(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 — orders search Orders — request body — body

Referenced models: Search — orders search Orders — 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 — orders search Orders — response body

Referenced models: Search — orders search Orders — response body

Schemas

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

Search — orders search Orders — 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 of the last successfully read resource. This token is used for pagination to retrieve the next set of results.
filterGroups	array	Required within parent	An array of filter groups used to specify the search criteria. Each filter group contains multiple filters that define the conditions for the search.
filterGroups[]	Model	Each item	Expand Search — orders search Orders — request body — body filter Groups item
limit	integer	Required within parent	An integer specifying the maximum number of results to return. This value controls the page size of the search results. Format: int32
properties	array	Required within parent	An array of strings specifying the properties to be returned in the search results. If a specified property is not present on the requested object(s), it will be ignored.
properties[]	string	Each item
query	string	Optional	A string used to perform a full-text search across the specified properties.
sorts	array	Required within parent	An array of strings that define the sorting order of the search results. Each string specifies a property to sort by, optionally followed by a direction (e.g., 'propertyName ASC').
sorts[]	string	Each item

Referenced models: Search — orders search Orders — request body — body filter Groups item

Search — orders search Orders — 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 — orders search Orders — 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 — orders create Order — 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 — orders search Orders — response body — paging, Create — orders create Order — response body

Search — orders search Orders — 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 filter by.
filters[]	Model	Each item	Expand Search — orders search Orders — request body — body filter Groups item filters item

Referenced models: Search — orders search Orders — request body — body filter Groups item filters item

Search — orders search Orders — 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 — orders get Orders — response body — paging next
prev	Model	Optional	Expand Search — orders search Orders — response body — paging prev

Referenced models: List — orders get Orders — response body — paging next, Search — orders search Orders — response body — paging prev

Create — orders create Order — 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 used to trace the 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 an array of their historical values, each with a timestamp. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Read — orders get Order — 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, each containing a category, message, and context.
warnings[]	Model	Each item	Expand Read — orders get Order — response body — warnings item

Referenced models: Read — orders get Order — response body — warnings item, Read — orders get Order — response body — properties With History value item

Search — orders search Orders — 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 when using range-based operators like 'BETWEEN'.
operator	string	Required within parent	The operator that defines how the property value should be compared to the filter's value(s). 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 to filter by. 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 if an object meets the filter criteria.
values	array	Optional	An array of strings representing multiple values to compare against the specified property. Used with operators that support multiple values, such as 'IN' or 'NOT_IN'.
values[]	string	Each item

List — orders get Orders — 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 set of results in a paged response.
link	string	Optional	A string URL that points to the next page of results.

Search — orders search Orders — 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 of the last item on the previous page, used to navigate to the previous set of results.
link	string	Optional	A string URL that provides a direct link to the previous page of results.

Read — orders get Order — 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 properties as key-value pairs where both keys and values are strings. Additional keys: see wildcard field
context.*	string	Additional keys
message	string	Required within parent	A string containing the message that describes the warning.

Policy, approvals and errors

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

Official provider source