Zum Hauptinhalt springen
POST
/
crm
/
v3
/
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 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "propertiesWithHistory": [
    "<string>"
  ],
  "idProperty": "<string>",
  "inputs": [
    {
      "id": "<string>"
    }
  ],
  "properties": [
    "<string>"
  ]
}'
{
  "completedAt": "2023-11-07T05:31:56Z",
  "numErrors": 123,
  "requestedAt": "2023-11-07T05:31:56Z",
  "startedAt": "2023-11-07T05:31:56Z",
  "links": {},
  "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"
    }
  ],
  "errors": [
    {
      "subCategory": {},
      "context": {},
      "links": {},
      "id": "<string>",
      "category": "<string>",
      "message": "<string>",
      "errors": [
        {
          "subCategory": "<string>",
          "code": "<string>",
          "in": "<string>",
          "context": "{\"missingScopes\":[\"scope1\",\"scope2\"]}",
          "message": "<string>"
        }
      ],
      "status": "<string>"
    }
  ],
  "status": "PENDING"
}
Produits pris en charge
Exige l'un des produits suivants ou un produit supérieur.
Marketing HubMarketing HubGratuit
Sales HubSales HubGratuit
Service HubService HubGratuit
Content HubContent HubGratuit

​
Portées requises

Cette API requiert l’une des portées suivantes :
  • crm.objects.deals.read

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
archived
boolean
default:false

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

Body

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.

​
propertiesWithHistory
string[]
required

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

​
inputs
object[]
required
​
properties
string[]
required

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

​
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.

Response

successful operation

A public object batch response object

​
completedAt
string<date-time>
required

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

​
startedAt
string<date-time>
required

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

​
results
object[]
required
​
status
enum<string>
required

Statut de la demande de traitement par lots : « EN ATTENTE », « TRAITEMENT », « ANNULÉ » ou « TERMINÉ »

Available options:
PENDING,
PROCESSING,
CANCELED,
COMPLETE
​
numErrors
integer
​
requestedAt
string<date-time>

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

​
links
object

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

​
errors
object[]
⌘I