Contacts
TheContact
object is used to represent an existing point of contact at a company in a CRM system.The Contact object
Properties
first_name
Stringlast_name
Stringaccount
Stringaddresses
Address[]The Address object
Address
object is used to represent an entity's address.{"street_1": "50 Bowling Green Dr","street_2": "Golden Gate Park","city": "San Francisco","state": "CA","postal_code": "94122","country": "USA","address_type": "Shipping"}
Properties
street_1
Stringstreet_2
Stringcity
Stringstate
Stringpostal_code
Stringcountry
EnumAF
, AX
, AL
, DZ
, AS
, AD
, AO
, AI
, AQ
, AG
, AR
, AM
, AW
, AU
, AT
, AZ
, BS
, BH
, BD
, BB
, BY
, BE
, BZ
, BJ
, BM
, BT
, BO
, BQ
, BA
, BW
, BV
, BR
, IO
, BN
, BG
, BF
, BI
, CV
, KH
, CM
, CA
, KY
, CF
, TD
, CL
, CN
, CX
, CC
, CO
, KM
, CG
, CD
, CK
, CR
, CI
, HR
, CU
, CW
, CY
, CZ
, DK
, DJ
, DM
, DO
, EC
, EG
, SV
, GQ
, ER
, EE
, SZ
, ET
, FK
, FO
, FJ
, FI
, FR
, GF
, PF
, TF
, GA
, GM
, GE
, DE
, GH
, GI
, GR
, GL
, GD
, GP
, GU
, GT
, GG
, GN
, GW
, GY
, HT
, HM
, VA
, HN
, HK
, HU
, IS
, IN
, ID
, IR
, IQ
, IE
, IM
, IL
, IT
, JM
, JP
, JE
, JO
, KZ
, KE
, KI
, KW
, KG
, LA
, LV
, LB
, LS
, LR
, LY
, LI
, LT
, LU
, MO
, MG
, MW
, MY
, MV
, ML
, MT
, MH
, MQ
, MR
, MU
, YT
, MX
, FM
, MD
, MC
, MN
, ME
, MS
, MA
, MZ
, MM
, NA
, NR
, NP
, NL
, NC
, NZ
, NI
, NE
, NG
, NU
, NF
, KP
, MK
, MP
, NO
, OM
, PK
, PW
, PS
, PA
, PG
, PY
, PE
, PH
, PN
, PL
, PT
, PR
, QA
, RE
, RO
, RU
, RW
, BL
, SH
, KN
, LC
, MF
, PM
, VC
, WS
, SM
, ST
, SA
, SN
, RS
, SC
, SL
, SG
, SX
, SK
, SI
, SB
, SO
, ZA
, GS
, KR
, SS
, ES
, LK
, SD
, SR
, SJ
, SE
, CH
, SY
, TW
, TJ
, TZ
, TH
, TL
, TG
, TK
, TO
, TT
, TN
, TR
, TM
, TC
, TV
, UG
, UA
, AE
, GB
, UM
, US
, UY
, UZ
, VU
, VE
, VN
, VG
, VI
, WF
, EH
, YE
, ZM
, ZW
, or - in cases where there is no clear mapping - the original value passed through.address_type
EnumBILLING
, SHIPPING
, or - in cases where there is no clear mapping - the original value passed through.email_addresses
EmailAddress[]The EmailAddress object
EmailAddress
object is used to represent an entity's email address.Properties
email_address
Stringemail_address_type
Stringphone_numbers
PhoneNumber[]The PhoneNumber object
PhoneNumber
object is used to represent an entity's phone number.{"phone_number": "+3198675309","phone_number_type": "Mobile"}
Properties
phone_number
Stringphone_number_type
Stringlast_activity_at
Stringremote_created_at
Stringremote_data
RemoteData[]remote_was_deleted
Booleanid
Stringremote_id
Stringfield_mappings
Objectremote_fields
RemoteField[]{"first_name": "Gil","last_name": "Feig","account": "0958cbc6-6040-430a-848e-aafacbadf4ae","addresses": [{"street_1": "50 Bowling Green Dr","street_2": "Golden Gate Park","city": "San Francisco","state": "CA","postal_code": "94122","country": "USA","address_type": "Shipping"}],"email_addresses": [{"email_address": "[email protected]","email_address_type": "Work"}],"phone_numbers": [{"phone_number": "+13785579223","phone_number_type": "Mobile"}],"last_activity_at": "2022-02-10T00:00:00Z","remote_created_at": "2021-11-10T00:00:00Z","remote_data": [{"path": "/contacts","data": ["Varies by platform"]}],"remote_was_deleted": true,"id": "03455bc6-6040-430a-848e-aafacbfdf4fg","remote_id": "19202938","field_mappings": {"organization_defined_targets": {"custom_key": "custom_value"},"linked_account_defined_targets": {"custom_key": "custom_value"}},"remote_fields": [{"value": {}}]}
/contacts
Returns a list of Contact
objects.
Header Parameters
Authorization
StringX-Account-Token
StringQuery & Path Parameters
account_id
Stringcreated_after
Stringcreated_before
Stringcursor
Stringexpand
Stringinclude_deleted_data
Booleaninclude_remote_data
Booleaninclude_remote_fields
Booleanmodified_after
Stringmodified_before
Stringpage_size
Integerremote_id
String{"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw","previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ","results": [{"first_name": "Gil","last_name": "Feig","account": "0958cbc6-6040-430a-848e-aafacbadf4ae","addresses": [{"street_1": "50 Bowling Green Dr","street_2": "Golden Gate Park","city": "San Francisco","state": "CA","postal_code": "94122","country": "USA","address_type": "Shipping"}],"email_addresses": [{"email_address": "[email protected]","email_address_type": "Work"}],"phone_numbers": [{"phone_number": "+13785579223","phone_number_type": "Mobile"}],"last_activity_at": "2022-02-10T00:00:00Z","remote_created_at": "2021-11-10T00:00:00Z","remote_data": [{"path": "/contacts","data": ["Varies by platform"]}],"remote_was_deleted": true,"id": "03455bc6-6040-430a-848e-aafacbfdf4fg","remote_id": "19202938","field_mappings": {"organization_defined_targets": {"custom_key": "custom_value"},"linked_account_defined_targets": {"custom_key": "custom_value"}},"remote_fields": [{"value": {}}]}]}

Accelo
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringemail_addresses
EmailAddress[]email_address
stringemail_address_type
stringfirst_name
Stringlast_activity_at
Stringlast_name
Stringphone_numbers
PhoneNumber[]phone_number
stringphone_number_type
stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
ActiveCampaign
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringemail_addresses
EmailAddress[]email_address
stringemail_address_type
stringfirst_name
Stringlast_activity_at
Stringlast_name
Stringphone_numbers
PhoneNumber[]phone_number
stringphone_number_type
stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Affinity
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringemail_addresses
EmailAddress[]email_address
stringemail_address_type
stringfirst_name
Stringlast_name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Capsule
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringfirst_name
Stringlast_activity_at
Stringlast_name
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Close
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringemail_addresses
EmailAddress[]email_address
stringemail_address_type
stringfirst_name
Stringlast_name
Stringphone_numbers
PhoneNumber[]phone_number
stringphone_number_type
stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Copper
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringaddresses
Address[]street_1
stringstreet_2
stringcity
stringstate
stringpostal_code
stringcountry
stringaddress_type
stringemail_addresses
EmailAddress[]email_address
stringemail_address_type
stringfirst_name
Stringlast_activity_at
Stringlast_name
Stringphone_numbers
PhoneNumber[]phone_number
stringphone_number_type
stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
HubSpot
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringfirst_name
Stringlast_activity_at
Stringlast_name
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Insightly
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringemail_addresses
EmailAddress[]email_address
stringemail_address_type
stringfirst_name
Stringlast_name
Stringphone_numbers
PhoneNumber[]phone_number
stringphone_number_type
stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Keap
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringaddresses
Address[]street_1
stringstreet_2
stringcity
stringstate
stringpostal_code
stringcountry
stringaddress_type
stringemail_addresses
EmailAddress[]email_address
stringemail_address_type
stringfirst_name
Stringlast_name
Stringphone_numbers
PhoneNumber[]phone_number
stringphone_number_type
stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Microsoft Dynamics 365 Sales
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringaddresses
Address[]street_1
stringstreet_2
stringcity
stringstate
stringpostal_code
stringcountry
stringaddress_type
stringemail_addresses
EmailAddress[]email_address
stringemail_address_type
stringfirst_name
Stringlast_name
Stringphone_numbers
PhoneNumber[]phone_number
stringphone_number_type
stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Nutshell
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringaddresses
Address[]street_1
stringstreet_2
stringcity
stringstate
stringpostal_code
stringcountry
stringaddress_type
stringemail_addresses
EmailAddress[]email_address
stringemail_address_type
stringfirst_name
Stringlast_activity_at
Stringlast_name
Stringphone_numbers
PhoneNumber[]phone_number
stringphone_number_type
stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Pipedrive
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringfirst_name
Stringlast_activity_at
Stringlast_name
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Pipeliner
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringfirst_name
Stringlast_name
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Salesflare
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringaddresses
Address[]street_1
stringstreet_2
stringcity
stringstate
stringpostal_code
stringcountry
stringaddress_type
stringemail_addresses
EmailAddress[]email_address
stringemail_address_type
stringfirst_name
Stringlast_name
Stringphone_numbers
PhoneNumber[]phone_number
stringphone_number_type
stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Salesforce
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringfirst_name
Stringlast_activity_at
Stringlast_name
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
SugarCRM
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringaddresses
Address[]street_1
stringstreet_2
stringcity
stringstate
stringpostal_code
stringcountry
stringaddress_type
stringemail_addresses
EmailAddress[]email_address
stringemail_address_type
stringfirst_name
Stringlast_name
Stringphone_numbers
PhoneNumber[]phone_number
stringphone_number_type
stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Teamleader
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
addresses
Address[]street_1
stringstreet_2
stringcity
stringstate
stringpostal_code
stringcountry
stringaddress_type
stringemail_addresses
EmailAddress[]email_address
stringemail_address_type
stringfirst_name
Stringlast_name
Stringphone_numbers
PhoneNumber[]phone_number
stringphone_number_type
stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Teamwork CRM
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringaddresses
Address[]street_1
stringstreet_2
stringcity
stringstate
stringpostal_code
stringcountry
stringaddress_type
stringemail_addresses
EmailAddress[]email_address
stringemail_address_type
stringfirst_name
Stringlast_name
Stringphone_numbers
PhoneNumber[]phone_number
stringphone_number_type
stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Vtiger
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringemail_addresses
EmailAddress[]email_address
stringemail_address_type
stringfirst_name
Stringlast_activity_at
Stringlast_name
Stringphone_numbers
PhoneNumber[]phone_number
stringphone_number_type
stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Zendesk Sell
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringaddresses
Address[]street_1
stringstreet_2
stringcity
stringstate
stringpostal_code
stringcountry
stringaddress_type
stringemail_addresses
EmailAddress[]email_address
stringemail_address_type
stringfirst_name
Stringlast_name
Stringphone_numbers
PhoneNumber[]phone_number
stringphone_number_type
stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Zoho CRM
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringemail_addresses
EmailAddress[]email_address
stringemail_address_type
stringfirst_name
Stringlast_activity_at
Stringlast_name
Stringphone_numbers
PhoneNumber[]phone_number
stringphone_number_type
stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String/contacts
Creates a Contact
object with the given values.
Header Parameters
Authorization
StringX-Account-Token
StringQuery & Path Parameters
is_debug_mode
Booleanrun_async
BooleanBody Parameters
model
ObjectModel Parameters
first_name
Stringlast_name
Stringaccount
Stringid
field in the Account table.addresses
Arrayemail_addresses
Arrayphone_numbers
Arraylast_activity_at
Stringintegration_params
Objectlinked_account_params
Object{"model": {"first_name": "Gil","last_name": "Feig","account": "0958cbc6-6040-430a-848e-aafacbadf4ae","addresses": [{"street_1": "50 Bowling Green Dr","street_2": "Golden Gate Park","city": "San Francisco","state": "CA","postal_code": "94122","country": "USA","address_type": "Shipping"}],"email_addresses": [{"email_address": "[email protected]","email_address_type": "Work"}],"phone_numbers": [{"phone_number": "+13785579223","phone_number_type": "Mobile"}],"last_activity_at": "2022-02-10T00:00:00Z"}}
{"model": {"first_name": "Gil","last_name": "Feig","account": "0958cbc6-6040-430a-848e-aafacbadf4ae","addresses": [{"street_1": "50 Bowling Green Dr","street_2": "Golden Gate Park","city": "San Francisco","state": "CA","postal_code": "94122","country": "USA","address_type": "Shipping"}],"email_addresses": [{"email_address": "[email protected]","email_address_type": "Work"}],"phone_numbers": [{"phone_number": "+13785579223","phone_number_type": "Mobile"}],"last_activity_at": "2022-02-10T00:00:00Z","remote_created_at": "2021-11-10T00:00:00Z","remote_data": [{"path": "/contacts","data": ["Varies by platform"]}],"remote_was_deleted": true,"id": "03455bc6-6040-430a-848e-aafacbfdf4fg","remote_id": "19202938","field_mappings": {"organization_defined_targets": {"custom_key": "custom_value"},"linked_account_defined_targets": {"custom_key": "custom_value"}},"remote_fields": [{"value": {}}]},"warnings": [{"source": {"pointer": "/age"},"title": "Unrecognized Field","detail": "An unrecognized field, age, was passed in with request data.","problem_type": "UNRECOGNIZED_FIELD"}],"errors": [{"source": {"pointer": "/model/custom_fields"},"title": "Missing Required Field","detail": "custom_fields is a required field on model.","problem_type": "MISSING_REQUIRED_FIELD"}],"logs": [{"log_id": "99433219-8017-4acd-bb3c-ceb23d663832","dashboard_view": "https://app.merge.dev/logs/99433219-8017-4acd-bb3c-ceb23d663832","log_summary": {"url": "https://harvest.greenhouse.io/v1/candidates/","method": "POST","status_code": 200}}]}

HubSpot
Merge supports Passthrough Requests to this platform's API
Supported POST Body Parameters
email_addresses
EmailAddress[]email_address
stringemail_address_type
stringfirst_name
Stringlast_name
Stringphone_numbers
PhoneNumber[]phone_number
stringphone_number_type
stringremote_created_at
Stringremote_id
String
Zendesk Sell
Merge supports Passthrough Requests to this platform's API
Supported POST Body Parameters
account
Stringaddresses
Address[]street_1
stringstreet_2
stringcity
stringstate
stringpostal_code
stringcountry
stringaddress_type
stringemail_addresses
EmailAddress[]email_address
stringemail_address_type
stringfirst_name
Stringlast_name
Stringphone_numbers
PhoneNumber[]phone_number
stringphone_number_type
stringremote_created_at
Stringremote_id
String
Zoho CRM
Merge supports Passthrough Requests to this platform's API
Supported POST Body Parameters
account
Stringemail_addresses
EmailAddress[]email_address
stringemail_address_type
stringfirst_name
Stringlast_activity_at
Stringlast_name
Stringphone_numbers
PhoneNumber[]phone_number
stringphone_number_type
stringremote_created_at
Stringremote_id
String
Pipedrive

Salesforce
/contacts/{id}
Returns a Contact
object with the given id
.
Header Parameters
Authorization
StringX-Account-Token
StringQuery & Path Parameters
expand
Stringid
Stringinclude_remote_data
Booleaninclude_remote_fields
Boolean{"first_name": "Gil","last_name": "Feig","account": "0958cbc6-6040-430a-848e-aafacbadf4ae","addresses": [{"street_1": "50 Bowling Green Dr","street_2": "Golden Gate Park","city": "San Francisco","state": "CA","postal_code": "94122","country": "USA","address_type": "Shipping"}],"email_addresses": [{"email_address": "[email protected]","email_address_type": "Work"}],"phone_numbers": [{"phone_number": "+13785579223","phone_number_type": "Mobile"}],"last_activity_at": "2022-02-10T00:00:00Z","remote_created_at": "2021-11-10T00:00:00Z","remote_data": [{"path": "/contacts","data": ["Varies by platform"]}],"remote_was_deleted": true,"id": "03455bc6-6040-430a-848e-aafacbfdf4fg","remote_id": "19202938","field_mappings": {"organization_defined_targets": {"custom_key": "custom_value"},"linked_account_defined_targets": {"custom_key": "custom_value"}},"remote_fields": [{"value": {}}]}

Accelo
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringemail_addresses
EmailAddress[]email_address
stringemail_address_type
stringfirst_name
Stringlast_activity_at
Stringlast_name
Stringphone_numbers
PhoneNumber[]phone_number
stringphone_number_type
stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
ActiveCampaign
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringemail_addresses
EmailAddress[]email_address
stringemail_address_type
stringfirst_name
Stringlast_activity_at
Stringlast_name
Stringphone_numbers
PhoneNumber[]phone_number
stringphone_number_type
stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Affinity
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringemail_addresses
EmailAddress[]email_address
stringemail_address_type
stringfirst_name
Stringlast_name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Capsule
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringfirst_name
Stringlast_activity_at
Stringlast_name
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Close
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringemail_addresses
EmailAddress[]email_address
stringemail_address_type
stringfirst_name
Stringlast_name
Stringphone_numbers
PhoneNumber[]phone_number
stringphone_number_type
stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Copper
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringaddresses
Address[]street_1
stringstreet_2
stringcity
stringstate
stringpostal_code
stringcountry
stringaddress_type
stringemail_addresses
EmailAddress[]email_address
stringemail_address_type
stringfirst_name
Stringlast_activity_at
Stringlast_name
Stringphone_numbers
PhoneNumber[]phone_number
stringphone_number_type
stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
HubSpot
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringfirst_name
Stringlast_activity_at
Stringlast_name
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Insightly
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringemail_addresses
EmailAddress[]email_address
stringemail_address_type
stringfirst_name
Stringlast_name
Stringphone_numbers
PhoneNumber[]phone_number
stringphone_number_type
stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Keap
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringaddresses
Address[]street_1
stringstreet_2
stringcity
stringstate
stringpostal_code
stringcountry
stringaddress_type
stringemail_addresses
EmailAddress[]email_address
stringemail_address_type
stringfirst_name
Stringlast_name
Stringphone_numbers
PhoneNumber[]phone_number
stringphone_number_type
stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Microsoft Dynamics 365 Sales
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringaddresses
Address[]street_1
stringstreet_2
stringcity
stringstate
stringpostal_code
stringcountry
stringaddress_type
stringemail_addresses
EmailAddress[]email_address
stringemail_address_type
stringfirst_name
Stringlast_name
Stringphone_numbers
PhoneNumber[]