Read a batch of projects
Read a batch of CRM objects by their internal IDs or unique property values. This endpoint allows you to retrieve multiple objects in a single request, which is useful for efficiently gathering data on a set of objects. 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, each representing an object to be read in the batch operation.
An array of strings specifying the properties to be returned for each object in the batch. If a specified property is not present on an object, it will be ignored.
An array of strings specifying the properties to be returned along with their history of previous values for each object in the batch. If a specified property is not present on an object, it will be ignored.
A string representing the name of a property whose values are unique for the object type. This property is used to identify objects uniquely.
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 for additional information related to the batch operation.
The date and time when the batch operation was requested, in ISO 8601 format.