Retrieve subscriptions
Retrieve a batch of CRM subscription objects by their IDs, including specified properties and their histories.
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 containing an ID of the object to be read. These IDs are used to identify the objects for which the properties and historical values are requested.
An array of strings representing the properties to be returned for each object. If any specified properties are not present on the requested objects, they will be ignored.
An array of strings representing 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.
A string representing the name of a property whose values are unique for this object type. This is optional and can be used to identify objects by a unique property value instead of the internal 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 that represent 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 that provide additional context or actions related to the batch operation.
The date and time when the batch operation was requested, in ISO 8601 format.