Pular para o conteúdo principal
POST
Ler objetos em lote

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

O tipo de objeto do CRM a ser lido em lote, como contatos, empresas ou negócios.

Parâmetros de consulta

archived
boolean
padrão:false

Indica se devem ser retornados apenas os resultados que foram arquivados. O padrão é falso.

Corpo

application/json

Especifica a entrada para a leitura de um lote de objetos do CRM, incluindo matrizes de IDs de objetos, nomes de propriedades solicitadas (com histórico opcional) e uma propriedade de identificação exclusiva opcional.

inputs
object[]
obrigatório

Uma matriz de objetos SimplePublicObjectId, cada um contendo um ID de um objeto a ser lido.

properties
string[]
obrigatório

Uma matriz de strings que representam as propriedades a serem retornadas na resposta para cada objeto.

propertiesWithHistory
string[]
obrigatório

Uma matriz de strings que indica as propriedades para as quais os valores históricos devem ser retornados, juntamente com os valores atuais.

idProperty
string

Uma string que especifica o nome de uma propriedade cujos valores são únicos para o tipo de objeto, usada para identificar os objetos.

Resposta

successful operation

Um objeto de resposta em lote de objeto público

completedAt
string<date-time>
obrigatório

A data e hora em que a operação em lote foi concluída, no formato ISO 8601.

results
object[]
obrigatório

Uma matriz de itens SimplePublicObject que são o resultado da operação em lote.

startedAt
string<date-time>
obrigatório

A data e a hora em que a operação em lote foi iniciada, no formato ISO 8601.

status
enum<string>
obrigatório

O status atual da operação em lote. Os valores válidos incluem 'PENDENTE', 'PROCESSANDO', 'CANCELADO' e 'CONCLUÍDO'.

Opções disponíveis:
CANCELED,
COMPLETE,
PENDING,
PROCESSING

Um mapa de nomes de links para URIs associadas relacionadas à operação em lote.

requestedAt
string<date-time>

A data e a hora em que a operação em lote foi solicitada, no formato ISO 8601.

Última modificação em 6 de outubro de 2026