Read
GET {{baseUrl}}/crm/v3/objects/contacts/:contactId?properties=<string>&properties=<string>&propertiesWithHistory=<string>&propertiesWithHistory=<string>&associations=<string>&associations=<string>&archived=false
Read an Object identified by {contactId}. {contactId} refers to the internal object ID. Control what is returned via the properties query param.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
properties | string | A 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. | |
properties | string | A 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. | |
propertiesWithHistory | string | A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. | |
propertiesWithHistory | string | A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. | |
associations | string | A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored. | |
associations | string | A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored. | |
archived | boolean | Whether to return only results that have been archived. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"createdAt":"\u003cdateTime\u003e","id":"\u003cstring\u003e","properties":{"qui_8":"\u003cstring\u003e"},"updatedAt":"\u003cdateTime\u003e","propertiesWithHistory":{"proident_f":[{"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","associations":{"etc":{"results":[{"id":"\u003cstring\u003e","type":"\u003cstring\u003e"},{"id":"\u003cstring\u003e","type":"\u003cstring\u003e"}],"paging":{"next":{"after":"\u003cstring\u003e","link":"\u003cstring\u003e"},"prev":{"before":"\u003cstring\u003e","link":"\u003cstring\u003e"}}}}}