Retrieve Contacts
Retrieve Contacts from any connected CRM
Path parameters
id of the contact you want to retrive.
Query parameters
Set to true to include data from the original CRM software.
Headers
The connection token
Response
Example response
{
"first_name": "John",
"last_name": "Doe",
"email_addresses": [
{
"email": "john.doe@example.com",
"type": "WORK"
}
],
"phone_numbers": [
{
"phone": "1234567890",
"type": "WORK"
}
],
"addresses": [
{
"street": "123 Main St",
"city": "Anytown",
"state": "CA",
"zip": "12345",
"country": "USA",
"type": "WORK"
}
],
"user_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
"field_mappings": {
"fav_dish": "broccoli",
"fav_color": "red"
},
"id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
"remote_id": "id_1",
"remote_data": {
"fav_dish": "broccoli",
"fav_color": "red"
},
"created_at": "2024-10-01T12:00:00Z",
"modified_at": "2024-10-01T12:00:00Z"
}Changes
Changed in 6 of the 18 revisions of this API.66813
- ○
removed the
MOBILEenum value from thephone_numbers/items/phone_typeresponse property for the response status200response-property-enum-value-removed
- ○
removed the
PERSONALenum value from theaddresses/items/address_typeresponse property for the response status200response-property-enum-value-removed
- ○
removed the
PERSONALenum value from theemail_addresses/items/email_address_typeresponse property for the response status200response-property-enum-value-removed
- ○
removed the
WORKenum value from theaddresses/items/address_typeresponse property for the response status200response-property-enum-value-removed
- ○
removed the
WORKenum value from theemail_addresses/items/email_address_typeresponse property for the response status200response-property-enum-value-removed
- ○
removed the
WORKenum value from thephone_numbers/items/phone_typeresponse property for the response status200response-property-enum-value-removed
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ○
- ●
added the new
COMPANYenum value to theemail_addresses/items/owner_typeresponse property for the response status200response-property-enum-value-added
- ●
added the new
CONTACTenum value to theemail_addresses/items/owner_typeresponse property for the response status200response-property-enum-value-added
- ●
added the new
MOBILEenum value to thephone_numbers/items/phone_typeresponse property for the response status200response-property-enum-value-added
- ●
added the new
PERSONALenum value to theaddresses/items/address_typeresponse property for the response status200response-property-enum-value-added
- ●
added the new
PERSONALenum value to theemail_addresses/items/email_address_typeresponse property for the response status200response-property-enum-value-added
- ●
added the new
WORKenum value to theaddresses/items/address_typeresponse property for the response status200response-property-enum-value-added
- ●
added the new
WORKenum value to theemail_addresses/items/email_address_typeresponse property for the response status200response-property-enum-value-added
- ●
added the new
WORKenum value to thephone_numbers/items/phone_typeresponse property for the response status200response-property-enum-value-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ●
- ▲
the response property
addressesbecame nullable for the status200response-property-became-nullable
- ▲
the response property
addresses/items/address_typebecame nullable for the status200response-property-became-nullable
- ▲
the response property
addresses/items/citybecame nullable for the status200response-property-became-nullable
- ▲
the response property
addresses/items/countrybecame nullable for the status200response-property-became-nullable
- ▲
the response property
addresses/items/owner_typebecame nullable for the status200response-property-became-nullable
- ▲
the response property
addresses/items/postal_codebecame nullable for the status200response-property-became-nullable
- ▲
the response property
addresses/items/statebecame nullable for the status200response-property-became-nullable
- ▲
the response property
addresses/items/street_1became nullable for the status200response-property-became-nullable
- ▲
the response property
addresses/items/street_2became nullable for the status200response-property-became-nullable
- ▲
the response property
created_atbecame nullable for the status200response-property-became-nullable
- ▲
the response property
email_addressesbecame nullable for the status200response-property-became-nullable
- ▲
the response property
email_addresses/items/email_addressbecame nullable for the status200response-property-became-nullable
- ▲
the response property
email_addresses/items/email_address_typebecame nullable for the status200response-property-became-nullable
- ▲
the response property
email_addresses/items/owner_typebecame nullable for the status200response-property-became-nullable
- ▲
the response property
field_mappingsbecame nullable for the status200response-property-became-nullable
- ▲
the response property
first_namebecame nullable for the status200response-property-became-nullable
- ▲
the response property
idbecame nullable for the status200response-property-became-nullable
- ▲
the response property
last_namebecame nullable for the status200response-property-became-nullable
- ▲
the response property
modified_atbecame nullable for the status200response-property-became-nullable
- ▲
the response property
phone_numbersbecame nullable for the status200response-property-became-nullable
- ▲
the response property
phone_numbers/items/owner_typebecame nullable for the status200response-property-became-nullable
- ▲
the response property
phone_numbers/items/phone_numberbecame nullable for the status200response-property-became-nullable
- ▲
the response property
phone_numbers/items/phone_typebecame nullable for the status200response-property-became-nullable
- ▲
the response property
remote_databecame nullable for the status200response-property-became-nullable
- ▲
the response property
remote_idbecame nullable for the status200response-property-became-nullable
- ▲
the response property
user_idbecame nullable for the status200response-property-became-nullable
- ▲
the response property
created_atbecame optional for the status200response-property-became-optional
- ▲
the response property
field_mappingsbecame optional for the status200response-property-became-optional
- ▲
the response property
modified_atbecame optional for the status200response-property-became-optional
- ▲
the response property
remote_databecame optional for the status200response-property-became-optional
- ▲
the
created_atresponse's property type/format changed fromobject/tostring/date-timefor status200response-property-type-changed
- ▲
the
modified_atresponse's property type/format changed fromobject/tostring/date-timefor status200response-property-type-changed
- ○
the endpoint scheme security
bearerwas removed from the APIapi-security-removed
This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ▲
- ▲
the
created_atresponse's property type/format changed fromstring/date-timetoobject/for status200response-property-type-changed
- ▲
the
modified_atresponse's property type/format changed fromstring/date-timetoobject/for status200response-property-type-changed
- ○
the endpoint scheme security
bearerwas added to the APIapi-security-added
- ○
the response property
created_atbecame required for the status200response-property-became-required
- ○
the response property
field_mappingsbecame required for the status200response-property-became-required
- ○
the response property
modified_atbecame required for the status200response-property-became-required
- ○
the response property
remote_databecame required for the status200response-property-became-required
This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ▲
- ▲
the response property
addressesbecame nullable for the status200response-property-became-nullable
- ▲
the response property
addresses/items/address_typebecame nullable for the status200response-property-became-nullable
- ▲
the response property
addresses/items/citybecame nullable for the status200response-property-became-nullable
- ▲
the response property
addresses/items/countrybecame nullable for the status200response-property-became-nullable
- ▲
the response property
addresses/items/owner_typebecame nullable for the status200response-property-became-nullable
- ▲
the response property
addresses/items/postal_codebecame nullable for the status200response-property-became-nullable
- ▲
the response property
addresses/items/statebecame nullable for the status200response-property-became-nullable
- ▲
the response property
addresses/items/street_1became nullable for the status200response-property-became-nullable
- ▲
the response property
addresses/items/street_2became nullable for the status200response-property-became-nullable
- ▲
the response property
created_atbecame nullable for the status200response-property-became-nullable
- ▲
the response property
email_addressesbecame nullable for the status200response-property-became-nullable
- ▲
the response property
email_addresses/items/email_addressbecame nullable for the status200response-property-became-nullable
- ▲
the response property
email_addresses/items/email_address_typebecame nullable for the status200response-property-became-nullable
- ▲
the response property
email_addresses/items/owner_typebecame nullable for the status200response-property-became-nullable
- ▲
the response property
field_mappingsbecame nullable for the status200response-property-became-nullable
- ▲
the response property
first_namebecame nullable for the status200response-property-became-nullable
- ▲
the response property
idbecame nullable for the status200response-property-became-nullable
- ▲
the response property
last_namebecame nullable for the status200response-property-became-nullable
- ▲
the response property
modified_atbecame nullable for the status200response-property-became-nullable
- ▲
the response property
phone_numbersbecame nullable for the status200response-property-became-nullable
- ▲
the response property
phone_numbers/items/owner_typebecame nullable for the status200response-property-became-nullable
- ▲
the response property
phone_numbers/items/phone_numberbecame nullable for the status200response-property-became-nullable
- ▲
the response property
phone_numbers/items/phone_typebecame nullable for the status200response-property-became-nullable
- ▲
the response property
remote_databecame nullable for the status200response-property-became-nullable
- ▲
the response property
remote_idbecame nullable for the status200response-property-became-nullable
- ▲
the response property
user_idbecame nullable for the status200response-property-became-nullable
- ▲
the response property
created_atbecame optional for the status200response-property-became-optional
- ▲
the response property
field_mappingsbecame optional for the status200response-property-became-optional
- ▲
the response property
modified_atbecame optional for the status200response-property-became-optional
- ▲
the response property
remote_databecame optional for the status200response-property-became-optional
- ▲
the
created_atresponse's property type/format changed fromobject/tostring/date-timefor status200response-property-type-changed
- ▲
the
modified_atresponse's property type/format changed fromobject/tostring/date-timefor status200response-property-type-changed
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ▲
- ○
the endpoint scheme security
bearerwas removed from the APIapi-security-removed
- ○