Pular para o conteúdo principal
POST
/
crm
/
v3
/
objects
/
{objectType}
/
batch
/
read
Ler um lote de objetos por ID interno ou por valores de propriedade exclusivos
curl --request POST \
  --url https://api.hubapi.com/crm/v3/objects/{objectType}/batch/read \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "inputs": [
    {
      "id": "<string>"
    }
  ],
  "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"
}

Produtos suportados

Requer um dos seguintes produtos ou superior.
Marketing HubMarketing Hub -Enterprise
Sales HubSales Hub -Enterprise
Service HubService Hub -Enterprise
Content HubContent Hub -Enterprise

Autorizações

Authorization
string
header
obrigatório

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

Parâmetros de caminho

objectType
string
obrigatório

Parâmetros de consulta

archived
boolean
padrão:false

Se apenas os resultados que foram arquivados devem ser retornados.

Corpo

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[]
obrigatório
properties
string[]
obrigatório

Key-value pairs for setting properties for the new object.

propertiesWithHistory
string[]
obrigatório

Key-value pairs for setting properties for the new object and their histories.

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

A public object batch response object

completedAt
string<date-time>
obrigatório

The timestamp when the batch processing was completed, in ISO 8601 format.

results
object[]
obrigatório
startedAt
string<date-time>
obrigatório

The timestamp when the batch processing began, in ISO 8601 format.

status
enum<string>
obrigatório

The status of the batch processing request: "PENDING", "PROCESSING", "CANCELLED", or "COMPLETE"

Opções disponíveis:
CANCELED,
COMPLETE,
PENDING,
PROCESSING
errors
object[]

An object containing relevant links related to the batch request.

numErrors
integer<int32>
requestedAt
string<date-time>

The timestamp when the batch request was initially made, in ISO 8601 format.

Last modified on December 8, 2025