Read a batch of leads by internal ID, or unique property values

Lee un lote de leads por ID interno o valores de propiedad únicos

curl --request POST \
  --url https://api.hubapi.com/crm/objects/2026-09/leads/batch/read \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "inputs": [
    {
      "id": "430001"
    }
  ],
  "properties": [
    "<string>"
  ],
  "propertiesWithHistory": [
    "<string>"
  ],
  "idProperty": "<string>"
}
'

import requests

url = "https://api.hubapi.com/crm/objects/2026-09/leads/batch/read"

payload = {
    "inputs": [{ "id": "430001" }],
    "properties": ["<string>"],
    "propertiesWithHistory": ["<string>"],
    "idProperty": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    inputs: [{id: '430001'}],
    properties: ['<string>'],
    propertiesWithHistory: ['<string>'],
    idProperty: '<string>'
  })
};

fetch('https://api.hubapi.com/crm/objects/2026-09/leads/batch/read', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hubapi.com/crm/objects/2026-09/leads/batch/read",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'inputs' => [
        [
                'id' => '430001'
        ]
    ],
    'properties' => [
        '<string>'
    ],
    'propertiesWithHistory' => [
        '<string>'
    ],
    'idProperty' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hubapi.com/crm/objects/2026-09/leads/batch/read"

	payload := strings.NewReader("{\n  \"inputs\": [\n    {\n      \"id\": \"430001\"\n    }\n  ],\n  \"properties\": [\n    \"<string>\"\n  ],\n  \"propertiesWithHistory\": [\n    \"<string>\"\n  ],\n  \"idProperty\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.hubapi.com/crm/objects/2026-09/leads/batch/read")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"inputs\": [\n    {\n      \"id\": \"430001\"\n    }\n  ],\n  \"properties\": [\n    \"<string>\"\n  ],\n  \"propertiesWithHistory\": [\n    \"<string>\"\n  ],\n  \"idProperty\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hubapi.com/crm/objects/2026-09/leads/batch/read")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"inputs\": [\n    {\n      \"id\": \"430001\"\n    }\n  ],\n  \"properties\": [\n    \"<string>\"\n  ],\n  \"propertiesWithHistory\": [\n    \"<string>\"\n  ],\n  \"idProperty\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "completedAt": "2023-11-07T05:31:56Z",
  "results": [
    {
      "archived": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "properties": {},
      "updatedAt": "2023-11-07T05:31:56Z",
      "archivedAt": "2023-11-07T05:31:56Z",
      "objectWriteTraceId": "<string>",
      "propertiesWithHistory": {},
      "url": "<string>",
      "warnings": [
        {
          "category": "<string>",
          "context": {},
          "message": "<string>"
        }
      ]
    }
  ],
  "startedAt": "2023-11-07T05:31:56Z",
  "status": "CANCELED",
  "links": {},
  "requestedAt": "2023-11-07T05:31:56Z"
}

{
  "completedAt": "2023-11-07T05:31:56Z",
  "results": [
    {
      "archived": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "properties": {},
      "updatedAt": "2023-11-07T05:31:56Z",
      "archivedAt": "2023-11-07T05:31:56Z",
      "objectWriteTraceId": "<string>",
      "propertiesWithHistory": {},
      "url": "<string>",
      "warnings": [
        {
          "category": "<string>",
          "context": {},
          "message": "<string>"
        }
      ]
    }
  ],
  "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"
}

{
  "message": "Invalid input (details will vary based on the error)",
  "correlationId": "aeb5f871-7f07-4993-9211-075dc63e7cbf",
  "category": "VALIDATION_ERROR",
  "links": {
    "knowledge-base": "https://www.hubspot.com/products/service/knowledge-base"
  }
}

POST

crm

objects

2026-09

leads

batch

read

Lee un lote de leads por ID interno o valores de propiedad únicos

curl --request POST \
  --url https://api.hubapi.com/crm/objects/2026-09/leads/batch/read \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "inputs": [
    {
      "id": "430001"
    }
  ],
  "properties": [
    "<string>"
  ],
  "propertiesWithHistory": [
    "<string>"
  ],
  "idProperty": "<string>"
}
'

import requests

url = "https://api.hubapi.com/crm/objects/2026-09/leads/batch/read"

payload = {
    "inputs": [{ "id": "430001" }],
    "properties": ["<string>"],
    "propertiesWithHistory": ["<string>"],
    "idProperty": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    inputs: [{id: '430001'}],
    properties: ['<string>'],
    propertiesWithHistory: ['<string>'],
    idProperty: '<string>'
  })
};

fetch('https://api.hubapi.com/crm/objects/2026-09/leads/batch/read', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hubapi.com/crm/objects/2026-09/leads/batch/read",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'inputs' => [
        [
                'id' => '430001'
        ]
    ],
    'properties' => [
        '<string>'
    ],
    'propertiesWithHistory' => [
        '<string>'
    ],
    'idProperty' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hubapi.com/crm/objects/2026-09/leads/batch/read"

	payload := strings.NewReader("{\n  \"inputs\": [\n    {\n      \"id\": \"430001\"\n    }\n  ],\n  \"properties\": [\n    \"<string>\"\n  ],\n  \"propertiesWithHistory\": [\n    \"<string>\"\n  ],\n  \"idProperty\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.hubapi.com/crm/objects/2026-09/leads/batch/read")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"inputs\": [\n    {\n      \"id\": \"430001\"\n    }\n  ],\n  \"properties\": [\n    \"<string>\"\n  ],\n  \"propertiesWithHistory\": [\n    \"<string>\"\n  ],\n  \"idProperty\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hubapi.com/crm/objects/2026-09/leads/batch/read")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"inputs\": [\n    {\n      \"id\": \"430001\"\n    }\n  ],\n  \"properties\": [\n    \"<string>\"\n  ],\n  \"propertiesWithHistory\": [\n    \"<string>\"\n  ],\n  \"idProperty\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "completedAt": "2023-11-07T05:31:56Z",
  "results": [
    {
      "archived": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "properties": {},
      "updatedAt": "2023-11-07T05:31:56Z",
      "archivedAt": "2023-11-07T05:31:56Z",
      "objectWriteTraceId": "<string>",
      "propertiesWithHistory": {},
      "url": "<string>",
      "warnings": [
        {
          "category": "<string>",
          "context": {},
          "message": "<string>"
        }
      ]
    }
  ],
  "startedAt": "2023-11-07T05:31:56Z",
  "status": "CANCELED",
  "links": {},
  "requestedAt": "2023-11-07T05:31:56Z"
}

{
  "completedAt": "2023-11-07T05:31:56Z",
  "results": [
    {
      "archived": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "properties": {},
      "updatedAt": "2023-11-07T05:31:56Z",
      "archivedAt": "2023-11-07T05:31:56Z",
      "objectWriteTraceId": "<string>",
      "propertiesWithHistory": {},
      "url": "<string>",
      "warnings": [
        {
          "category": "<string>",
          "context": {},
          "message": "<string>"
        }
      ]
    }
  ],
  "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"
}

{
  "message": "Invalid input (details will vary based on the error)",
  "correlationId": "aeb5f871-7f07-4993-9211-075dc63e7cbf",
  "category": "VALIDATION_ERROR",
  "links": {
    "knowledge-base": "https://www.hubspot.com/products/service/knowledge-base"
  }
}

Supported products

Required Scopes

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 que se va a leer. Estos ID se usan para especificar qué objetos se deben incluir en la operación de lectura por lotes.

Show child attributes

properties

string[]

requerido

Un conjunto de cadenas que representan las propiedades que se devolverán para cada objeto. Si una propiedad especificada no existe en un objeto, se ignorará.

propertiesWithHistory

string[]

requerido

Un conjunto de cadenas que representan las propiedades que se devolverán junto con su historial de valores anteriores. Usar este parámetro puede reducir el número de objetos que se pueden leer en una sola solicitud.

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.

Show child attributes

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

links

object

Un mapa de nombres de enlaces a URI asociados que proporcionan información adicional sobre la operación por lotes.

Show child attributes

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

Cuenta y configuración

Gestión de aplicaciones

Autenticación

Automatización

CMS

Preferencias de comunicación

Conversaciones

CRM

Data Studio

Eventos

Archivos

Marketing

Reuniones

Ingresos

Webhooks

Registro de webhooks

Read a batch of leads by internal ID, or unique property values

Autorizaciones

Parámetros de consulta

Cuerpo

Respuesta