Sign in

v14

latestOpenAPI 3.0.0raw.githubusercontent.com2026-05-279719892.3 MB
Batch

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

Retrieve a batch of calls by ID.

post/crm/objects/2026-03/calls/batch/read

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.

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: "PENDING", "PROCESSING", "CANCELLED", or "COMPLETE"