Read a batch of quotes 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.
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 objects, each containing an 'id' field, representing the CRM objects to be read.
An array of property names to be returned in the response. Each element is a string representing a property name.
An array of property names for which the history of previous values should be returned. Each element is a string representing a property name.
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 instances representing the results of the batch operation.
The date and time when the batch operation 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 related to the batch operation.
The date and time when the batch operation was requested, in ISO 8601 format.