Sign in

v5

latestOpenAPI 3.0.12026-07-13133674.3 KB
Batch

Retrieve a batch of contacts

Retrieve a batch of contacts by ID (contactId) or unique property value (idProperty).

post/crm/objects/2026-09/{objectType}/batch/read

Path parameters

objectTypestring required

Query parameters

archivedboolean

Whether to return only results that have been archived.

Request body

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.

Example request

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

Response

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.

numErrorsinteger

The total number of errors that occurred during the batch operation.

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".