Read a batch of contacts by internal ID, or unique property values
POST {{baseUrl}}/crm/v3/objects/contacts/batch/read?archived=false
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
archived | boolean | Whether to return only results that have been archived. |
Request Body
{"inputs"=>[{"id"=>"<string>"}, {"id"=>"<string>"}], "properties"=>["<string>", "<string>"], "propertiesWithHistory"=>["<string>", "<string>"], "idProperty"=>"<string>"}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
{"completedAt":"\u003cdateTime\u003e","results":[{"createdAt":"\u003cdateTime\u003e","id":"\u003cstring\u003e","properties":{"proidentc1":"\u003cstring\u003e","dolore81":"\u003cstring\u003e"},"updatedAt":"\u003cdateTime\u003e","propertiesWithHistory":{"non0":[{"sourceType":"\u003cstring\u003e","timestamp":"\u003cdateTime\u003e","value":"\u003cstring\u003e","sourceId":"\u003cstring\u003e","sourceLabel":"\u003cstring\u003e","updatedByUserId":"\u003cinteger\u003e"},{"sourceType":"\u003cstring\u003e","timestamp":"\u003cdateTime\u003e","value":"\u003cstring\u003e","sourceId":"\u003cstring\u003e","sourceLabel":"\u003cstring\u003e","updatedByUserId":"\u003cinteger\u003e"}]},"archived":"\u003cboolean\u003e","archivedAt":"\u003cdateTime\u003e"},{"createdAt":"\u003cdateTime\u003e","id":"\u003cstring\u003e","properties":{"adipisicing2e":"\u003cstring\u003e"},"updatedAt":"\u003cdateTime\u003e","propertiesWithHistory":{"do5_3":[{"sourceType":"\u003cstring\u003e","timestamp":"\u003cdateTime\u003e","value":"\u003cstring\u003e","sourceId":"\u003cstring\u003e","sourceLabel":"\u003cstring\u003e","updatedByUserId":"\u003cinteger\u003e"},{"sourceType":"\u003cstring\u003e","timestamp":"\u003cdateTime\u003e","value":"\u003cstring\u003e","sourceId":"\u003cstring\u003e","sourceLabel":"\u003cstring\u003e","updatedByUserId":"\u003cinteger\u003e"}]},"archived":"\u003cboolean\u003e","archivedAt":"\u003cdateTime\u003e"}],"startedAt":"\u003cdateTime\u003e","status":"COMPLETE","requestedAt":"\u003cdateTime\u003e","links":{"incididunt_dd1":"\u003cstring\u003e","qui_9":"\u003cstring\u003e"}}