Read a batch of appointments 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.
Path Parameters
The type of CRM object to read in batch, such as contacts, companies, or deals.
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 containing an ID of the object to be read.
An array of strings representing the properties to be returned in the response. If any specified properties are not present on the requested objects, they will be ignored.
An array of strings indicating the properties to be returned along with their history of previous values. If any specified properties are not present on the requested objects, they 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 results from the batch operation, each represented as a SimplePublicObject.
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.