HUhubspot
Batch

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

Changed on

Retrieve records by record ID or include the idProperty parameter to retrieve records by a custom unique value property.

post/crm/objects/2025-09/0-162/batch/read

Request

  • Base URL
    https://api.hubapi.com
  • URL
    https://api.hubapi.com/crm/objects/2025-09/0-162/batch/read
  • Auth
    none required

Query parameters

archivedboolean

Whether to return only results that have been archived.

Request body

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.

propertiesstring[] required

An array of the property names to be returned in the response. If a specified property is not present on the requested object(s), it will be ignored.

propertiesWithHistorystring[] required

An array of the property names to be returned along with their history of previous values. If a specified property is not present on the requested object(s), it will be ignored.

Example request

{
  "inputs": [
    {
      "id": "430001"
    }
  ]
}

Response

successful operation

completedAtstring date-time required

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

linksobject

A map of link names to associated URIs, providing additional information or actions related to the batch operation.

requestedAtstring date-time

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

startedAtstring date-time required

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

status'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING' required

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

Changes