Saltar al contenido principal
POST
Leer objetos por lotes

Supported products

Autorizaciones

Authorization
string
header
requerido

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

Parámetros de ruta

objectType
string
requerido

El tipo de objeto del CRM que se leerá en lote, como contactos, empresas o negocios.

Parámetros de consulta

archived
boolean
predeterminado:false

Si se devuelven solo los resultados que se han archivado. La opción predeterminada es falso.

Cuerpo

application/json

Especifica la entrada para leer un lote de objetos del CRM, que incluye conjuntos de ID de objetos, nombres de propiedades solicitadas (con historial opcional) y una propiedad de identificación única opcional.

inputs
object[]
requerido

Un conjunto de objetos SimplePublicObjectId, cada uno con el ID de un objeto para leer.

properties
string[]
requerido

Una matriz de cadenas que representan las propiedades que se devolverán en la respuesta para cada objeto.

propertiesWithHistory
string[]
requerido

Un conjunto de cadenas que indican las propiedades para las que se deben devolver los valores anteriores, junto con los valores actuales.

idProperty
string

Una cadena que especifica el nombre de una propiedad cuyos valores son únicos para el tipo de objeto y se utiliza para identificar los objetos.

Respuesta

successful operation

Un objeto de respuesta de lote de objetos públicos

completedAt
string<date-time>
requerido

La fecha y hora en que se completó la operación por lotes, en formato ISO 8601.

results
object[]
requerido

Un conjunto de elementos SimplePublicObject que son el resultado de la operación por lotes.

startedAt
string<date-time>
requerido

La fecha y la hora en que comenzó la operación por lotes, en formato ISO 8601.

status
enum<string>
requerido

El estado actual de la operación por lotes. Los valores válidos son "PENDING", "PROCESSING", "CANCELED" y "COMPLETE".

Opciones disponibles:
CANCELED,
COMPLETE,
PENDING,
PROCESSING

Un mapa de nombres de enlaces a URI asociados relacionados con la operación por lotes.

requestedAt
string<date-time>

La fecha y la hora en que se solicitó la operación por lotes, en formato ISO 8601.

Última modificación el 6 de octubre de 2026