POST
/
crm
/
v3
/
objects
/
contacts
/
batch
/
read
Retrieve a batch of contacts
curl --request POST \
  --url https://api.hubapi.com/crm/v3/objects/contacts/batch/read \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "propertiesWithHistory": "",
  "idProperty": "<string>",
  "inputs": [
    {
      "id": "<string>"
    }
  ],
  "properties": ""
}'
{
  "completedAt": "2023-11-07T05:31:56Z",
  "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"
    }
  ],
  "status": ""
}
Supported products
Requires one of the following products or higher.
Marketing HubMarketing HubFree
Sales HubSales HubFree
Service HubService HubFree
Content HubContent HubFree

​
Required Scopes

This API requires one of the following scopes:
  • crm.objects.contacts.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

Whether to return only results that have been archived.

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.

Response

200
application/json

successful operation

A public object batch response object