Saltar al contenido principal
POST
/
crm
/
v3
/
objects
/
0-3
/
batch
/
read
Lee un lote de negocios por ID interno, o valores de propiedad únicos
curl --request POST \
  --url https://api.hubapi.com/crm/v3/objects/0-3/batch/read \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "inputs": [
    {
      "id": "430001"
    }
  ],
  "properties": [
    "<string>"
  ],
  "propertiesWithHistory": [
    "<string>"
  ],
  "idProperty": "<string>"
}
'
{
  "completedAt": "2023-11-07T05:31:56Z",
  "results": [
    {
      "archived": false,
      "createdAt": "2019-10-30T03:30:17.883Z",
      "id": "512",
      "properties": {
        "property_checkbox": "false",
        "property_date": "1572480000000",
        "property_dropdown": "choice_b",
        "property_multiple_checkboxes": "chocolate;strawberry",
        "property_number": "17",
        "property_radio": "option_1",
        "property_string": "value"
      },
      "updatedAt": "2019-12-07T16:50:06.678Z"
    }
  ],
  "startedAt": "2023-11-07T05:31:56Z",
  "status": "CANCELED",
  "errors": [
    {
      "category": "<string>",
      "context": {},
      "errors": [
        {
          "message": "<string>",
          "code": "<string>",
          "context": "{missingScopes=[scope1, scope2]}",
          "in": "<string>",
          "subCategory": "<string>"
        }
      ],
      "links": {},
      "message": "<string>",
      "status": "<string>",
      "id": "<string>",
      "subCategory": {}
    }
  ],
  "links": {},
  "numErrors": 123,
  "requestedAt": "2023-11-07T05:31:56Z"
}

Productos compatibles

Se requiere uno de los siguientes productos o productos de ediciones superiores.
Marketing HubMarketing Hub -Gratuito
Sales HubSales Hub -Gratuito
Service HubService Hub -Gratuito
Content HubContent Hub -Gratuito

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 quieren devolver solo los resultados que se han archivado.

Cuerpo

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[]
requerido
properties
string[]
requerido

Pares clave-valor para establecer las propiedades del objeto nuevo.

propertiesWithHistory
string[]
requerido

Pares clave-valor para establecer las propiedades del objeto nuevo y sus historiales.

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

A public object batch response object

completedAt
string<date-time>
requerido

La marca de tiempo en que se completó el procesamiento por lotes, en formato ISO 8601.

results
object[]
requerido
startedAt
string<date-time>
requerido

La marca de tiempo en que comenzó el procesamiento por lotes, en formato ISO 8601.

status
enum<string>
requerido

El estado actual de la solicitud de procesamiento por lotes, puede ser "PENDIENTE", "PROCESANDO", "CANCELADO" o "COMPLETADO".

Opciones disponibles:
CANCELED,
COMPLETE,
PENDING,
PROCESSING
errors
object[]

Un objeto que contiene los enlaces relevantes relacionados con la solicitud de procesamiento por lotes.

numErrors
integer<int32>

El número total de errores que se produjeron durante la operación.

requestedAt
string<date-time>

La marca de tiempo en la que se realizó inicialmente la solicitud del lote, en formato ISO 8601.

Last modified on December 8, 2025