Pular para o conteúdo principal
POST
Recuperar um lote de empresas

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 consulta

archived
boolean
padrão:false

Se apenas os resultados que foram arquivados devem ser retornados.

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

Matriz de objetos SimplePublicObjectId, cada um contendo um ID que especifica quais objetos do CRM devem ser lidos na operação em lote.

properties
string[]
obrigatório

Matriz de strings que representa as propriedades a serem retornadas para cada objeto na operação de leitura em lote.

propertiesWithHistory
string[]
obrigatório

Matriz de strings que representam as propriedades a serem retornadas, juntamente com o histórico de valores anteriores, para cada objeto na operação de leitura em lote.

idProperty
string

Ao usar uma propriedade de valor exclusivo personalizada para recuperar registros, este é o nome da propriedade. Não inclua esse parâmetro se estiver recuperando por ID de registro.

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 representam os resultados da operação em lote.

startedAt
string<date-time>
obrigatório

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

status
enum<string>
obrigatório

O status da solicitação de processamento em lote. O valor esperado é "CONCLUÍDO".

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

Um mapa de nomes de links para URIs associadas, fornecendo informações ou ações adicionais 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