HubSpot: Read a batch of deal split objects by their associated deal object internal ID

← Deal splits operations · Get started

Operation hubspot.deal_splits_get_deal_splits

Provider route: POST /deal-splits/2026-09/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["dealSplits"]["getDealSplits"]>[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.dealSplits.getDealSplits(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.deal_splits.get_deal_splits(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 Read a batch of deal split objects by their associated deal object internal ID — request body — body

Referenced models: Read a batch of deal split objects by their associated deal object internal ID — 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 Read a batch of deal split objects by their associated deal object internal ID — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Batch Response Deal To Deal Splits
$ (anyOf 2)	Model	Alternative	Expand Read a batch of deal split objects by their associated deal object internal ID — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Batch Response Deal To Deal Splits With Errors

Referenced models: Read a batch of deal split objects by their associated deal object internal ID — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Batch Response Deal To Deal Splits, Read a batch of deal split objects by their associated deal object internal ID — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Batch Response Deal To Deal Splits With Errors

Schemas

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

Read a batch of deal split objects by their associated deal object internal ID — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
inputs	array	Required within parent	An array of deal split inputs
inputs[]	Model	Each item	Expand Read a batch of deal split objects by their associated deal object internal ID — request body — body inputs item

Referenced models: Read a batch of deal split objects by their associated deal object internal ID — request body — body inputs item

Read a batch of deal split objects by their associated deal object internal ID — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Batch Response Deal To Deal Splits

Field	Type	Presence	Description and constraints
$	object	Root
completedAt	string	Required within parent	The timestamp indicating when the batch operation was completed, in date-time format. Format: date-time
links	object	Optional	A map of link names to associated URIs for additional resources or documentation. Additional keys: see wildcard field
links.*	string	Additional keys
requestedAt	string	Optional	The timestamp indicating when the batch operation was requested, in date-time format. Format: date-time
results	array	Required within parent	An array of deal-to-deal split objects representing the results of the batch operation.
results[]	Model	Each item	Expand Read a batch of deal split objects by their associated deal object internal ID — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item
startedAt	string	Required within parent	The timestamp indicating when the batch operation started, in date-time format. Format: date-time
status	string	Required within parent	The current status of the batch operation, with possible values: CANCELED, COMPLETE, PENDING, PROCESSING. Known values: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Read a batch of deal split objects by their associated deal object internal ID — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item

Read a batch of deal split objects by their associated deal object internal ID — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Batch Response Deal To Deal Splits With Errors

Field	Type	Presence	Description and constraints
$	object	Root
completedAt	string	Required within parent	The timestamp indicating when the batch operation was completed, in date-time format. Format: date-time
errors	array	Optional	An array of error objects detailing the errors that occurred during the batch operation.
errors[]	Model	Each item	Expand Read a batch of deal split objects by their associated deal object internal ID — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item
links	object	Optional	A map of link names to associated URIs for additional resources or documentation. Additional keys: see wildcard field
links.*	string	Additional keys
numErrors	JSON	Optional
numErrors (anyOf 1)	integer	Alternative	The total number of errors encountered during the batch operation. Format: int32
numErrors (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
requestedAt	string	Optional	The timestamp indicating when the batch operation was requested, in date-time format. Format: date-time
results	array	Required within parent	An array of deal-to-deal split objects representing the results of the batch operation.
results[]	Model	Each item	Expand Read a batch of deal split objects by their associated deal object internal ID — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item
startedAt	string	Required within parent	The timestamp indicating when the batch operation started, in date-time format. Format: date-time
status	string	Required within parent	The current status of the batch operation, with possible values: CANCELED, COMPLETE, PENDING, PROCESSING. Known values: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Read a batch of deal split objects by their associated deal object internal ID — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item, Read a batch of deal split objects by their associated deal object internal ID — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item

Read a batch of deal split objects by their associated deal object internal 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 identifier for the public object.

Read a batch of deal split objects by their associated deal object internal ID — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Required within parent	The unique identifier for the deal associated with the deal splits.
splits	array	Required within parent	An array of deal split objects, each representing a portion of the deal assigned to an owner.
splits[]	Model	Each item	Expand Read a batch of deal split objects by their associated deal object internal ID — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item splits item

Referenced models: Read a batch of deal split objects by their associated deal object internal ID — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item splits item

Read a batch of deal split objects by their associated deal object internal ID — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item

Field	Type	Presence	Description and constraints
$	object	Root	Ye olde error
category	string	Required within parent	The error category
context	object	Required within parent	Context about the error condition Additional keys: see wildcard field
context.*	array	Additional keys
context.*[]	string	Each item
errors	array	Required within parent	An array of ErrorDetail objects that provide further information about the error.
errors[]	Model	Each item	Expand Batch insert events — response body — errors item errors item
id	string	Optional	The id of the error
links	object	Required within parent	A map of link names to associated URIs containing documentation about the error or recommended remediation steps Additional keys: see wildcard field
links.*	string	Additional keys
message	string	Required within parent	The error message
status	string	Required within parent	A human readable message describing the error along with remediation steps where appropriate
subCategory	object	Optional	A specific category that contains more specific detail about the error

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

Read a batch of deal split objects by their associated deal object internal ID — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item splits 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 identifier used for tracing 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 arrays of historical values, each containing a value and its associated timestamp. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Read a batch of deal split objects by their associated deal object internal ID — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item splits item 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 associated with this object.

Referenced models: Read a batch of deal split objects by their associated deal object internal ID — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item splits item properties With History value item

Policy, approvals and errors

SDK function policy ID: hubspot.deal_splits_get_deal_splits. Catalog operation: deal_splits_get_deal_splits. 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.dealsplits.read_write"]

Official provider source