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 '{
  "propertiesWithHistory": [
    "<string>"
  ],
  "idProperty": "<string>",
  "inputs": [
    {
      "id": "<string>"
    }
  ],
  "properties": [
    "<string>"
  ]
}'
{
  "completedAt": "2023-11-07T05:31:56Z",
  "numErrors": 123,
  "requestedAt": "2023-11-07T05:31:56Z",
  "startedAt": "2023-11-07T05:31:56Z",
  "links": {},
  "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"
    }
  ],
  "errors": [
    {
      "subCategory": {},
      "context": {},
      "links": {},
      "id": "<string>",
      "category": "<string>",
      "message": "<string>",
      "errors": [
        {
          "subCategory": "<string>",
          "code": "<string>",
          "in": "<string>",
          "context": "{\"missingScopes\":[\"scope1\",\"scope2\"]}",
          "message": "<string>"
        }
      ],
      "status": "<string>"
    }
  ],
  "status": "PENDING"
}
Productos compatibles
Se requiere uno de los siguientes productos o productos de ediciones superiores.
Marketing HubMarketing HubGratuito
Sales HubSales HubGratuito
Service HubService HubGratuito
Content HubContent HubGratuito

Ámbitos Requeridos

Esta API requiere uno de los siguientes ámbitos:
  • crm.objects.deals.read

Authorizations

Authorization
string
header
required

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

Query Parameters

archived
boolean
default:false

Si se quieren devolver solo los resultados que se han archivado.

Body

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.

propertiesWithHistory
string[]
required

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

inputs
object[]
required
properties
string[]
required

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

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.

Response

successful operation

A public object batch response object

completedAt
string<date-time>
required

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

startedAt
string<date-time>
required

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

results
object[]
required
status
enum<string>
required

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

Available options:
PENDING,
PROCESSING,
CANCELED,
COMPLETE
numErrors
integer
requestedAt
string<date-time>

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

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

errors
object[]