HubSpot: Read a batch of deals by internal ID, or unique property values

← Deals operations · Get started

Operation hubspot.deals_batch_get_deals

Provider route: POST /crm/objects/2026-09/0-3/batch/read. 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"]["batchGetDeals"]>[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.batchGetDeals(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.batch_get_deals(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Optional	Additional keys: not allowed
query.archived	boolean	Optional	Default: false
body	Model	Required within parent	Expand Read a batch of deals by internal ID, or unique property values — request body — body

Referenced models: Read a batch of deals by internal ID, or unique property values — 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
$	JSON	Root
$ (anyOf 1)	Model	Alternative	Expand Create a batch of deals — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Deals Batch Response Simple Public Object
$ (anyOf 2)	Model	Alternative	Expand Create a batch of deals — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Deals Batch Response Simple Public Object With Errors

Referenced models: Create a batch of deals — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Deals Batch Response Simple Public Object, Create a batch of deals — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Deals Batch Response Simple Public Object With Errors

Schemas

2 more schemas are linked from the tables above, on the schema pages.

Read a batch of deals by internal ID, or unique property values — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Specifies the input for reading a batch of CRM objects, including arrays of object IDs, requested property names (with optional history), and an optional unique identifying property.
idProperty	string	Optional	When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.
inputs	array	Required within parent	An array of SimplePublicObjectId objects, each representing an object to be read in the batch operation.
inputs[]	Model	Each item	Expand Archive a batch of deals by ID — request body — body inputs item
properties	array	Required within parent	Key-value pairs for setting properties for the new object.
properties[]	string	Each item
propertiesWithHistory	array	Required within parent	Key-value pairs for setting properties for the new object and their histories.
propertiesWithHistory[]	string	Each item

Referenced models: Archive a batch of deals by ID — request body — body inputs item

Create a batch of deals — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Deals Batch Response Simple Public Object

Field	Type	Presence	Description and constraints
$	object	Root	A public object batch response object
completedAt	string	Required within parent	The timestamp when the batch processing was completed, in ISO 8601 format. Format: date-time
links	object	Optional	An object containing relevant links related to the batch request. Additional keys: see wildcard field
links.*	string	Additional keys
requestedAt	string	Optional	The timestamp when the batch request was initially made, in ISO 8601 format. Format: date-time
results	array	Required within parent	An array of SimplePublicObject items representing the results of the batch operation.
results[]	Model	Each item	Expand Create — deals create Deal — response body
startedAt	string	Required within parent	The timestamp when the batch processing began, in ISO 8601 format. Format: date-time
status	string	Required within parent	The status of the batch processing request. The expected value is "COMPLETE". Known values: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Create — deals create Deal — response body

Create a batch of deals — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Deals Batch Response Simple Public Object With Errors

Field	Type	Presence	Description and constraints
$	object	Root	Represents the result of a batch operation on CRM objects, including the processing status, batch results, timestamps, and a list of any errors encountered during the operation.
completedAt	string	Required within parent	The timestamp when the batch process was completed, in ISO 8601 format. Format: date-time
errors	array	Optional	An array of StandardError instances detailing any errors that occurred during the batch operation.
errors[]	Model	Each item	Expand Remove associations — response body — errors item
links	object	Optional	An object containing relevant links related to the batch request. Additional keys: see wildcard field
links.*	string	Additional keys
numErrors	JSON	Optional
numErrors (anyOf 1)	integer	Alternative	The number of errors encountered during the batch process. Format: int32
numErrors (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
requestedAt	string	Optional	The timestamp when the batch process was initiated, in ISO 8601 format. Format: date-time
results	array	Required within parent	An array of SimplePublicObject instances representing the successful results of the batch operation.
results[]	Model	Each item	Expand Create — deals create Deal — response body
startedAt	string	Required within parent	The timestamp when the batch process began execution, in ISO 8601 format. Format: date-time
status	string	Required within parent	The status of the batch processing request - "PENDING", "PROCESSING", "CANCELLED", or "COMPLETE" Known values: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Remove associations — response body — errors item, Create — deals create Deal — response body

Archive a batch of deals by ID — request body — body inputs item

Field	Type	Presence	Description and constraints
$	object	Root	Contains the Id of a Public Object
id	string	Required within parent	The unique ID of the object.

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

Remove associations — response body — errors item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a standard error response in the HubSpot API, providing detailed information about an error that occurred during an API request.
category	string	Required within parent	The main category of the error.
context	object	Required within parent	Additional context-specific information related to the error. Additional keys: see wildcard field
context.*	array	Additional keys
context.*[]	string	Each item
errors	array	Required within parent	The detailed error objects.
errors[]	Model	Each item	Expand Batch insert events — response body — errors item errors item
id	string	Optional	A unique ID for the error instance.
links	object	Required within parent	URLs linking to documentation or resources associated with the error. Additional keys: see wildcard field
links.*	string	Additional keys
message	string	Required within parent	A human-readable string describing the error and possible remediation steps.
status	string	Required within parent	The HTTP status code associated with the error.
subCategory	object	Optional	A more specific error category within each main category.

Referenced models: Batch insert events — response body — errors item errors item

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.

Policy, approvals and errors

SDK function policy ID: hubspot.deals_batch_get_deals. Catalog operation: deals_batch_get_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