Passer au contenu principal
POST
/
crm
/
v3
/
objects
/
{objectType}
/
batch
/
read
Lire un lot d'objets par ID interne ou par valeurs de propriétés uniques
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"
}

Produits pris en charge

Exige l'un des produits suivants ou un produit supérieur.
Marketing HubMarketing Hub -Entreprise
Sales HubSales Hub -Entreprise
Service HubService Hub -Entreprise
Content HubContent Hub -Entreprise

Autorisations

Authorization
string
header
requis

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

Paramètres de chemin

objectType
string
requis

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

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[]
requis
properties
string[]
requis

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

propertiesWithHistory
string[]
requis

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

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

A public object batch response object

completedAt
string<date-time>
requis

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

results
object[]
requis
startedAt
string<date-time>
requis

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

status
enum<string>
requis

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

Options disponibles:
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