POST
/
crm
/
v3
/
objects
/
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/v3/objects/deals/splits/batch/read \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "inputs": [
    {
      "id": "<string>"
    }
  ]
}'
{
  "completedAt": "2023-11-07T05:31:56Z",
  "requestedAt": "2023-11-07T05:31:56Z",
  "startedAt": "2023-11-07T05:31:56Z",
  "links": {},
  "results": [
    {
      "splits": [
        {
          "createdAt": "2023-11-07T05:31:56Z",
          "archived": false,
          "archivedAt": "2023-11-07T05:31:56Z",
          "propertiesWithHistory": "",
          "id": "",
          "properties": "",
          "updatedAt": "2023-11-07T05:31:56Z"
        }
      ],
      "id": "<string>"
    }
  ],
  "status": "PENDING"
}
Supported products
Requires one of the following products or higher.
Marketing HubMarketing HubFree
Sales HubSales HubEnterprise
Service HubService HubFree
Content HubContent HubFree

Required Scopes

This API requires one of the following scopes:
  • crm.dealsplits.read_write

Authorizations

Authorization
string
header
required

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

Body

application/json

Response

200
application/json

successful operation

The response is of type object.