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

Lire un lot de transactions par ID interne ou par valeurs de propriétés uniques

curl --request POST \
  --url https://api.hubapi.com/crm/v3/objects/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/v3/objects/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/v3/objects/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/v3/objects/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/v3/objects/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/v3/objects/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/v3/objects/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": 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",
  "links": {},
  "requestedAt": "2023-11-07T05:31:56Z"
}

{
  "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"
}

{
  "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

0-3

batch

read

Lire un lot de transactions par ID interne ou par valeurs de propriétés uniques

curl --request POST \
  --url https://api.hubapi.com/crm/v3/objects/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/v3/objects/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/v3/objects/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/v3/objects/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/v3/objects/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/v3/objects/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/v3/objects/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": 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",
  "links": {},
  "requestedAt": "2023-11-07T05:31:56Z"
}

{
  "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"
}

{
  "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

Paramètres de requête

archived

boolean

défaut:false

S'il faut renvoyer uniquement les résultats qui ont été archivés.

Corps

application/json

Spécifie l'entrée pour la lecture d'un lot d'objets CRM, y compris des tableaux d'ID d'objets, les noms de propriétés demandés (avec historique facultatif) et une propriété d'identification unique facultative.

inputs

object[]

requis

Un tableau d'objets SimplePublicObjectId, chacun contenant l'ID d'un objet à lire.

Show child attributes

properties

string[]

requis

Paires clé-valeur pour définir les propriétés du nouvel objet.

propertiesWithHistory

string[]

requis

Paires clé-valeur pour définir les propriétés du nouvel objet et leurs historiques.

idProperty

string

Lors de l'utilisation d'une propriété à valeur unique personnalisée, pour récupérer les fiches d'informations, le nom de la propriété. Ne pas inclure ce paramètre si l'extraction se fait par l'ID de la fiche d'informations.

Réponse

successful operation

Objet de réponse de lot d'objet public

completedAt

string<date-time>

requis

L'horodatage du moment où le traitement du lot a été terminé, au format ISO 8601.

results

object[]

requis

Un tableau d'éléments SimplePublicObject représentant les résultats de l'opération par lot.

Show child attributes

startedAt

string<date-time>

requis

L'horodatage du moment où le traitement du lot a commencé, au format ISO 8601.

status

enum<string>

requis

Statut de la demande de traitement par lots. La valeur attendue est « TERMINÉ ».

Options disponibles:

CANCELED,

COMPLETE,

PENDING,

PROCESSING

links

object

Un objet contenant des liens pertinents relatifs à la demande de lot.

Show child attributes

requestedAt

string<date-time>

L'horodatage du moment où la requête de lot a été faite initialement, au format ISO 8601.

Dernière modification le 1 avril 2026

Compte et paramètres

Gestion des applications

Authentification

Automatisation

CMS

Préférences de communication

Conversations

CRM

Événements

Fichiers

Marketing

Reporting

Planificateur

Webhooks

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

Paramètres de requête

Corps

Réponse