Saltar al contenido principal
POST
Lee un lote de contratos por ID interno o valores de propiedad únicos

Autorizaciones

Authorization
string
header
requerido

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

Parámetros de consulta

archived
boolean
predeterminado:false

Si se devolverán solo los resultados que se han archivado.

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

Un conjunto de cadenas que representan los nombres de las propiedades que se devolverán para cada objeto.

propertiesWithHistory
string[]
requerido

Un conjunto de cadenas que representan los nombres de las propiedades que se devolverán junto con su historial de valores anteriores para cada objeto.

idProperty
string

Al utilizar una propiedad de valor único personalizada para recuperar registros, el nombre de la propiedad. No incluyas este parámetro si estás recuperando por ID de registro.

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 objetos públicos simples que se procesaron en 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 que proporcionan información adicional sobre 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