Retrieve records by record ID or include the idProperty parameter to retrieve records by a custom unique value property.
Supported products
Required Scopes
The access token received from the authorization server in the OAuth 2.0 flow.
Whether to return only results that have been archived.
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.
Key-value pairs for setting properties for the new object.
Key-value pairs for setting properties for the new object and their histories.
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.
successful operation
A public object batch response object
The timestamp when the batch processing was completed, in ISO 8601 format.
The timestamp when the batch processing began, in ISO 8601 format.
The status of the batch processing request. Expected value is "COMPLETE".
CANCELED, COMPLETE, PENDING, PROCESSING An object containing relevant links related to the batch request.
The timestamp when the batch request was initially made, in ISO 8601 format.