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

POST /crm/objects/2026-03/{objectType}/batch/read

Einen Batch von Terminen nach interner ID oder eindeutigen Eigenschaftswerten lesen

cURL

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

200

{
  "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>"
    }
  ],
  "startedAt": "2023-11-07T05:31:56Z",
  "status": "CANCELED",
  "links": {},
  "requestedAt": "2023-11-07T05:31:56Z"
}

Supported products

Required Scopes

Autorisierungen

Authorization · string · header · erforderlich

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

Pfadparameter

objectType · string · erforderlich

„objectTypeId“ des Objekttyps

Abfrageparameter

archived · boolean · Standard: false

Ob nur Ergebnisse zurückgegeben werden sollen, die archiviert wurden.

Body

application/json

Gibt die Eingabe zum Lesen eines Batches von CRM-Objekten an, einschließlich Arrays von Objekt-IDs, angeforderten Eigenschaftsnamen (mit optionalem Verlauf) und einer optionalen eindeutigen identifizierenden Eigenschaft.

inputs · object[] · erforderlich

Show child attributes

properties · string[] · erforderlich

Schlüssel-Wert-Paare für Einstellungseigenschaften für das neue Objekt.

propertiesWithHistory · string[] · erforderlich

Schlüssel-Wert-Paare für Einstellungseigenschaften für das neue Objekt und deren Verläufe.

idProperty · string

Wenn eine benutzerdefinierte „Eindeutiger Wert“-Eigenschaft zum Abrufen von Datensätzen verwendet wird, der Name der Eigenschaft. Geben Sie diesen Parameter nicht an, wenn Sie nach Datensatz-ID abrufen.

Antwort

200

application/json

successful operation

Ein öffentliches Objekt-Batch-Antwortobjekt

completedAt · string<date-time> · erforderlich

Der Zeitstempel, wann die Batch-Verarbeitung abgeschlossen war (Format ISO 8601).

results · object[] · erforderlich

Show child attributes

startedAt · string<date-time> · erforderlich

Der Zeitstempel, wann die Batch-Verarbeitung gestartet wurde (Format ISO 8601).

status · enum<string> · erforderlich

Der Status der Batch-Verarbeitungsanfrage: „PENDING“, „PROCESSING“, „CANCELED“ oder „COMPLETE“.

Verfügbare Optionen: CANCELED, COMPLETE, PENDING, PROCESSING

links · object

Ein Objekt mit relevanten Links im Zusammenhang mit der Batch-Anfrage.

Show child attributes

requestedAt · string<date-time>

Der Zeitstempel, wann die Batch-Anfrage ursprünglich gestellt wurde (Format ISO 8601).