Batch

Read a batch of deals by internal ID, or unique property values

Retrieve records by record ID or include the idProperty parameter to retrieve records by a custom unique value property.

post/crm/objects/2026-03/0-3/batch/read

Request

archivedboolean

Whether to return only results that have been archived.

idPropertystring

When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.

propertiesstring[] required

Key-value pairs for setting properties for the new object.

propertiesWithHistorystring[] required

Key-value pairs for setting properties for the new object and their histories.

{
  "inputs": [
    {
      "id": "430001"
    }
  ]
}

successful operation

completedAtstring date-time required

The timestamp when the batch processing was completed, in ISO 8601 format.

linksobject

An object containing relevant links related to the batch request.

requestedAtstring date-time

The timestamp when the batch request was initially made, in ISO 8601 format.

startedAtstring date-time required

The timestamp when the batch processing began, in ISO 8601 format.

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

The status of the batch processing request. The expected value is "COMPLETE".

Sep 22, 20262026-03ae1f062de6b3 Revision changes
- info
  the endpoint scheme security oauth2 was removed from the API
Jun 23, 20262026-038c12e5df4449 Revision changes
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status