Read a batch of contacts by internal ID, or unique property values
POST {{baseUrl}}/crm/v3/objects/contacts/batch/read?hapikey=&archived=false
Read a list of contacts given a collection of IDs. Use the properties request body property to control which properties are returned.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
hapikey | null | ||
archived | boolean | Whether to return only results that have been archived. |
Request Body
{"inputs"=>[{"id"=>"<string>"}, {"id"=>"<string>"}], "properties"=>["<string>", "<string>"], "idProperty"=>"<string>"}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string |
RESPONSES
status: OK
{"completedAt":"\u003cdateTime\u003e","results":[{"createdAt":"2019-10-30T03:30:17.883Z","archived":false,"properties":{"property_number":"17","property_dropdown":"choice_b","property_radio":"option_1","property_string":"value","property_multiple_checkboxes":"chocolate;strawberry","property_checkbox":"false","property_date":"1572480000000"},"updatedAt":"2019-12-07T16:50:06.678Z"},{"createdAt":"2019-10-30T03:30:17.883Z","archived":false,"properties":{"property_number":"17","property_dropdown":"choice_b","property_radio":"option_1","property_string":"value","property_multiple_checkboxes":"chocolate;strawberry","property_checkbox":"false","property_date":"1572480000000"},"updatedAt":"2019-12-07T16:50:06.678Z"}],"startedAt":"\u003cdateTime\u003e","status":"\u003cstring\u003e","numErrors":"\u003cinteger\u003e","errors":[{"message":"Invalid input (details will vary based on the error)","correlationId":"aeb5f871-7f07-4993-9211-075dc63e7cbf","category":"VALIDATION_ERROR","links":{"knowledge-base":"https://www.hubspot.com/products/service/knowledge-base"}},{"message":"Invalid input (details will vary based on the error)","correlationId":"aeb5f871-7f07-4993-9211-075dc63e7cbf","category":"VALIDATION_ERROR","links":{"knowledge-base":"https://www.hubspot.com/products/service/knowledge-base"}}],"requestedAt":"\u003cdateTime\u003e"}