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/crm/objects/v3/deals/splits/batch/read

Request

  • Base URL
    https://api.hubapi.com
  • Auth
    OAuth 2
    Authorization codehttps://app.hubspot.com/oauth/authorize
    Token URLhttps://api.hubapi.com/oauth/v1/token
    Scopescrm.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