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

POST {{baseUrl}}/crm/v3/objects/users/batch/read?archived=false

Request Params

KeyDatatypeRequiredDescription
archivedbooleanWhether to return only results that have been archived.

Request Body

{"inputs"=>[{"id"=>"<string>"}, {"id"=>"<string>"}], "properties"=>["<string>", "<string>"], "propertiesWithHistory"=>["<string>", "<string>"], "idProperty"=>"<string>"}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
Acceptstring

RESPONSES

status: OK

{&quot;completedAt&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;results&quot;:[{&quot;createdAt&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;properties&quot;:{&quot;Ut_e9&quot;:&quot;\u003cstring\u003e&quot;,&quot;commodo_d2_&quot;:&quot;\u003cstring\u003e&quot;},&quot;updatedAt&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;archived&quot;:&quot;\u003cboolean\u003e&quot;,&quot;archivedAt&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;propertiesWithHistory&quot;:{&quot;velit_a8&quot;:[{&quot;sourceType&quot;:&quot;\u003cstring\u003e&quot;,&quot;timestamp&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;value&quot;:&quot;\u003cstring\u003e&quot;,&quot;sourceId&quot;:&quot;\u003cstring\u003e&quot;,&quot;sourceLabel&quot;:&quot;\u003cstring\u003e&quot;,&quot;updatedByUserId&quot;:&quot;\u003cinteger\u003e&quot;},{&quot;sourceType&quot;:&quot;\u003cstring\u003e&quot;,&quot;timestamp&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;value&quot;:&quot;\u003cstring\u003e&quot;,&quot;sourceId&quot;:&quot;\u003cstring\u003e&quot;,&quot;sourceLabel&quot;:&quot;\u003cstring\u003e&quot;,&quot;updatedByUserId&quot;:&quot;\u003cinteger\u003e&quot;}]}},{&quot;createdAt&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;properties&quot;:{&quot;fugiat_2&quot;:&quot;\u003cstring\u003e&quot;},&quot;updatedAt&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;archived&quot;:&quot;\u003cboolean\u003e&quot;,&quot;archivedAt&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;propertiesWithHistory&quot;:{&quot;magna_273&quot;:[{&quot;sourceType&quot;:&quot;\u003cstring\u003e&quot;,&quot;timestamp&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;value&quot;:&quot;\u003cstring\u003e&quot;,&quot;sourceId&quot;:&quot;\u003cstring\u003e&quot;,&quot;sourceLabel&quot;:&quot;\u003cstring\u003e&quot;,&quot;updatedByUserId&quot;:&quot;\u003cinteger\u003e&quot;},{&quot;sourceType&quot;:&quot;\u003cstring\u003e&quot;,&quot;timestamp&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;value&quot;:&quot;\u003cstring\u003e&quot;,&quot;sourceId&quot;:&quot;\u003cstring\u003e&quot;,&quot;sourceLabel&quot;:&quot;\u003cstring\u003e&quot;,&quot;updatedByUserId&quot;:&quot;\u003cinteger\u003e&quot;}],&quot;sunt_3&quot;:[{&quot;sourceType&quot;:&quot;\u003cstring\u003e&quot;,&quot;timestamp&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;value&quot;:&quot;\u003cstring\u003e&quot;,&quot;sourceId&quot;:&quot;\u003cstring\u003e&quot;,&quot;sourceLabel&quot;:&quot;\u003cstring\u003e&quot;,&quot;updatedByUserId&quot;:&quot;\u003cinteger\u003e&quot;},{&quot;sourceType&quot;:&quot;\u003cstring\u003e&quot;,&quot;timestamp&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;value&quot;:&quot;\u003cstring\u003e&quot;,&quot;sourceId&quot;:&quot;\u003cstring\u003e&quot;,&quot;sourceLabel&quot;:&quot;\u003cstring\u003e&quot;,&quot;updatedByUserId&quot;:&quot;\u003cinteger\u003e&quot;}]}}],&quot;startedAt&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;status&quot;:&quot;PENDING&quot;,&quot;requestedAt&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;links&quot;:{&quot;commodo_c&quot;:&quot;\u003cstring\u003e&quot;,&quot;mollit__8a&quot;:&quot;\u003cstring\u003e&quot;}}