Skip to main content
POST
/
crm
/
objects
/
v3
/
deals
/
splits
/
batch
/
read
Read a batch of deal split objects by their associated deal object internal ID
curl --request POST \
  --url https://api.hubapi.com/crm/objects/v3/deals/splits/batch/read \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "inputs": [
    {
      "id": "<string>"
    }
  ]
}
'
{
  "completedAt": "2023-11-07T05:31:56Z",
  "results": [
    {
      "id": "<string>",
      "splits": [
        {
          "archived": true,
          "createdAt": "2023-11-07T05:31:56Z",
          "id": "<string>",
          "properties": {},
          "updatedAt": "2023-11-07T05:31:56Z",
          "archivedAt": "2023-11-07T05:31:56Z",
          "objectWriteTraceId": "<string>",
          "propertiesWithHistory": {},
          "url": "<string>"
        }
      ]
    }
  ],
  "startedAt": "2023-11-07T05:31:56Z",
  "status": "CANCELED",
  "links": {},
  "requestedAt": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://developers.hubspot.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Supported products

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json
inputs
object[]
required

An array of deal split inputs

Response

successful operation

completedAt
string<date-time>
required

The timestamp indicating when the batch operation was completed, in date-time format.

results
object[]
required

An array of deal-to-deal split objects representing the results of the batch operation.

startedAt
string<date-time>
required

The timestamp indicating when the batch operation started, in date-time format.

status
enum<string>
required

The current status of the batch operation, with possible values: CANCELED, COMPLETE, PENDING, PROCESSING.

Available options:
CANCELED,
COMPLETE,
PENDING,
PROCESSING

A map of link names to associated URIs for additional resources or documentation.

requestedAt
string<date-time>

The timestamp indicating when the batch operation was requested, in date-time format.

Last modified on March 30, 2026