Read a batch of line items by internal ID, or unique property values
Retrieve a batch of CRM objects by their internal IDs or unique property values. This endpoint allows you to specify which properties and property histories to return for each object. It supports filtering results to include only archived objects if needed.
Supported products
Supported products
Required Scopes
Required Scopes
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Query Parameters
Whether to return only results that have been archived.
Body
Specifies the input for reading a batch of CRM objects, including arrays of object IDs, requested property names (with optional history), and an optional unique identifying property.
An array of SimplePublicObjectId objects, each containing an ID of a CRM object to be read.
An array of strings representing the names of the properties to be returned in the response.
An array of strings representing the names of the properties for which the history of previous values should be returned.
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.
Response
successful operation
A public object batch response object
The date and time when the batch operation was completed, in ISO 8601 format.
An array of SimplePublicObject items representing the results of the batch operation.
The date and time when the batch operation was started, in ISO 8601 format.
The current status of the batch operation. Valid values include 'PENDING', 'PROCESSING', 'CANCELED', and 'COMPLETE'.
CANCELED, COMPLETE, PENDING, PROCESSING A map of link names to associated URIs that provide additional information about the batch operation.
The date and time when the batch operation was requested, in ISO 8601 format.