Read a batch of tickets by internal ID, or unique property values
Retrieve a batch of CRM objects by their internal IDs or unique property values. This endpoint is useful for fetching multiple objects in a single request, which can help optimize performance and reduce the number of API calls needed. 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 by its ID.
An array of strings specifying the properties to be returned for each object. 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. This may reduce the maximum number of objects that can be read in a single request.
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 status of the batch processing request. The expected value is "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.