HUhubspot
Batch

Retrieve a batch of contacts

Changed on

Retrieve a batch of contacts by ID (contactId) or unique property value (idProperty).

post/crm/objects/2026-03/contacts/batch/read

Request

  • Base URL
    https://api.hubapi.com
  • URL
    https://api.hubapi.com/crm/objects/2026-03/contacts/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. The expected value is "COMPLETE".

Changes

  • 2026-0327aa774222ccRevision changes
    • info

      the endpoint scheme security oauth2 was removed from the API

  • 2026-03968d92765cf8Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status