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

Ler um lote de negócios por ID interno ou por valores de propriedade exclusivos

curl --request POST \
  --url https://api.hubapi.com/crm/objects/2026-03/0-3/batch/read \
  --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-03/0-3/batch/read"

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

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

print(response.text)

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

fetch('https://api.hubapi.com/crm/objects/2026-03/0-3/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-03/0-3/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 => [
    "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-03/0-3/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("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-03/0-3/batch/read")
  .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-03/0-3/batch/read")

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

request = Net::HTTP::Post.new(url)
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-03

0-3

batch

read

Ler um lote de negócios por ID interno ou por valores de propriedade exclusivos

curl --request POST \
  --url https://api.hubapi.com/crm/objects/2026-03/0-3/batch/read \
  --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-03/0-3/batch/read"

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

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

print(response.text)

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

fetch('https://api.hubapi.com/crm/objects/2026-03/0-3/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-03/0-3/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 => [
    "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-03/0-3/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("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-03/0-3/batch/read")
  .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-03/0-3/batch/read")

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

request = Net::HTTP::Post.new(url)
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

Parâmetros de consulta

archived

boolean

padrão:false

Se apenas os resultados que foram arquivados devem ser retornados.

Corpo

application/json

Especifica a entrada para a leitura de um lote de objetos do CRM, incluindo matrizes de IDs de objetos, nomes de propriedades solicitadas (com histórico opcional) e uma propriedade de identificação exclusiva opcional.

inputs

object[]

obrigatório

Uma matriz de objetos SimplePublicObjectId, cada um contendo o ID de um objeto a ser lido.

Show child attributes

properties

string[]

obrigatório

Pares de chave-valor para definir propriedades para o novo objeto.

propertiesWithHistory

string[]

obrigatório

Pares de chave-valor para definir propriedades para o novo objeto e seus históricos.

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

Um objeto de resposta em lote de objeto público

completedAt

string<date-time>

obrigatório

A data e hora em que o processamento em lote foi concluído, no formato ISO 8601.

results

object[]

obrigatório

Uma matriz de itens SimplePublicObject representando os resultados da operação em lote.

Show child attributes

startedAt

string<date-time>

obrigatório

A data e hora em que o processamento em lote foi iniciado, no formato ISO 8601.

status

enum<string>

obrigatório

O status da solicitação de processamento em lote. O valor esperado é "CONCLUÍDO".

Opções disponíveis:

CANCELED,

COMPLETE,

PENDING,

PROCESSING

links

object

Um objeto contendo links relevantes relacionados à solicitação em lote.

Show child attributes

requestedAt

string<date-time>

A data e hora em que a solicitação em lote foi feita inicialmente, no formato ISO 8601.

Última modificação em 6 de outubro de 2026

Conta e configurações

Gerenciamento de aplicativo

Autenticação

Automação

CMS

Preferências de comunicação

Conversas

CRM

Eventos

Arquivos

Marketing

Agendador

Webhooks

Diário de Webhooks

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

Parâmetros de consulta

Corpo

Resposta