Read

GET {{baseUrl}}/crm/v3/objects/contacts/:contactId?hapikey=&properties=<string>&properties=<string>&associations=<string>&associations=<string>&archived=false&idProperty=<string>

Read an Object identified by {contactId}. {contactId} refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.

Request Params

KeyDatatypeRequiredDescription
hapikeynull
propertiesstringA comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
propertiesstringA comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
associationsstringA comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
associationsstringA comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
archivedbooleanWhether to return only results that have been archived.
idPropertystringThe name of a property whose values are unique for this object type

RESPONSES

status: OK

{&quot;createdAt&quot;:&quot;2019-10-30T03:30:17.883Z&quot;,&quot;archived&quot;:false,&quot;properties&quot;:{&quot;property_number&quot;:&quot;17&quot;,&quot;property_dropdown&quot;:&quot;choice_b&quot;,&quot;property_radio&quot;:&quot;option_1&quot;,&quot;property_string&quot;:&quot;value&quot;,&quot;property_multiple_checkboxes&quot;:&quot;chocolate;strawberry&quot;,&quot;property_checkbox&quot;:&quot;false&quot;,&quot;property_date&quot;:&quot;1572480000000&quot;},&quot;updatedAt&quot;:&quot;2019-12-07T16:50:06.678Z&quot;}