Pular para o conteúdo principal
POST
Read a batch of objects by internal ID, or unique property values

Supported products

Autorizações

Authorization
string
header
obrigatório

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

Parâmetros de caminho

objectType
string
obrigatório

Parâmetros de consulta

archived
boolean
padrão:false

Whether to return only results that have been archived.

Corpo

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[]
obrigatório

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

properties
string[]
obrigatório

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[]
obrigatório

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.

Resposta

successful operation

A public object batch response object

completedAt
string<date-time>
obrigatório

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

results
object[]
obrigatório

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

startedAt
string<date-time>
obrigatório

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

status
enum<string>
obrigatório

The status of the batch processing request. The expected value is "COMPLETE".

Opções disponíveis:
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.

Última modificação em 13 de abril de 2026