Skip to main content
POST
Read a batch of appointments by internal ID, or unique property values

Supported products

Autorisations

Authorization
string
header
requis

The access token received from the authorization server in the OAuth 2.0 flow.

Paramètres de chemin

objectType
string
requis

Paramètres de requête

archived
boolean
défaut:false

Whether to return only results that have been archived.

Corps

application/json

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.

inputs
object[]
requis

An array of SimplePublicObjectId objects, each containing the ID of an object to be read.

properties
string[]
requis

An array of the property names to be returned in the response. If a specified property is not present on the requested object(s), it will be ignored.

propertiesWithHistory
string[]
requis

An array of the property names to be returned along with their history of previous values. If a specified property is not present on the requested object(s), it will be ignored.

idProperty
string

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.

Réponse

successful operation

A public object batch response object

completedAt
string<date-time>
requis

The timestamp when the batch processing was completed, in ISO 8601 format.

results
object[]
requis

An array of SimplePublicObject items representing the results of the batch operation.

startedAt
string<date-time>
requis

The timestamp when the batch processing began, in ISO 8601 format.

status
enum<string>
requis

The status of the batch processing request: "PENDING", "PROCESSING", "CANCELLED", or "COMPLETE"

Options disponibles:
CANCELED,
COMPLETE,
PENDING,
PROCESSING

A map of link names to associated URIs, providing additional information or actions related to the batch operation.

requestedAt
string<date-time>

The timestamp when the batch request was initially made, in ISO 8601 format.

Dernière modification le 1 avril 2026