Batch

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

Changed on

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

post/deal-splits/2026-09/batch/read

Request

  • Base URL
    https://api.hubapi.com
  • URL
    https://api.hubapi.com/deal-splits/2026-09/batch/read
  • Auth
    OAuth 2
    Authorization code: https://app.hubspot.com/oauth/authorize
    Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.dealsplits.read_write

Request body

Response

successful operation

completedAtstring date-time required

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

linksobject

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

requestedAtstring date-time

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

startedAtstring date-time required

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

status'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING' required

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

Changes

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      the endpoint scheme security private_apps was removed from the API

    • info

      added the success response with the status