Post /crm/v3/objects/0 3/batch/read Read

Get Batch of Deals By Internal ID

POST/crm/v3/objects/0-3/batch/read

Use it in a workflow

Add a step and choose the HubSpot connector.
Pick the Post /crm/v3/objects/0 3/batch/read Read action (under Deals).
Fill in the fields below, then reference the result from later steps as {{postCrmV3Objects03BatchReadRead.response.data}}.

Request

Query parameters

archivedboolean

Whether to return only results that have been archived.

Default false

Request body

Enter the body as JSON in the step's Body field.

idPropertystring

When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.

inputsarray<object>required

idstringrequired

The unique ID of the object.

propertiesarray<string>required

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

propertiesWithHistoryarray<string>required

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

json

{
  "inputs": [
    {
      "id": "430001"
    }
  ],
  "properties": [
    "string"
  ],
  "propertiesWithHistory": [
    "string"
  ],
  "idProperty": "string"
}

Response

Returns 200 with an object. Read it in later steps with {{postCrmV3Objects03BatchReadRead.response.data.<field>}}.

completedAtstring (date-time)

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

linksobject

An object containing relevant links related to the batch request.

requestedAtstring (date-time)

The timestamp when the batch request was initially made, in ISO 8601 format.

resultsarray<object>

archivedbooleanrequired

Whether the object is archived.

archivedAtstring (date-time)

The timestamp when the object was archived, in ISO 8601 format.

createdAtstring (date-time)required

The timestamp when the object was created, in ISO 8601 format.

idstringrequired

The unique ID of the object.

objectWriteTraceIdstring

An identifier used for tracing the creation or update request of the object.

propertiesobjectrequired

Key-value pairs representing the properties of the object.

propertiesWithHistoryobject

Key-value pairs representing the properties of the object along with their history.

updatedAtstring (date-time)required

The timestamp when the object was last updated, in ISO 8601 format.

urlstring

The URL associated with the object.

warningsarray<object>3 fields

startedAtstring (date-time)

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

statusstring

The status of the batch processing request. The expected value is "COMPLETE".

One ofCANCELEDCOMPLETEPENDINGPROCESSING

json

{
  "completedAt": "2025-01-01T00:00:00Z",
  "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": "2025-01-01T00:00:00Z",
  "status": "CANCELED",
  "links": {},
  "requestedAt": "2025-01-01T00:00:00Z"
}

Need more? See the HubSpot guide for connection setup and behaviour shared by every action.

Was this page helpful?