Read a batch of products by internal ID, or unique property values
Read a batch of CRM objects by their internal IDs or unique property values. This endpoint is useful for retrieving multiple objects in a single request, allowing for efficient data fetching. You can specify whether to include archived objects in the results.
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 representing the IDs of the objects to be read.
An array of strings representing the properties to be returned in the response. If a specified property is not present on the requested objects, it will be ignored.
An array of strings representing the properties to be returned along with their history of previous values. If a specified property is not present on the requested objects, it will be ignored.
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 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, providing additional resources or documentation related to the batch operation.
The date and time when the batch operation was requested, in ISO 8601 format.