Accounts
The Account object is used to represent a company in a CRM system.The Account object
Properties
ownerStringOptional
The account's owner.
nameStringOptional
The account's name.
descriptionStringOptional
The account's description.
industryStringOptional
The account's industry.
websiteStringOptional
The account's website.
number_of_employeesIntegerOptional
The account's number of employees.
addressesAddress[]Required
The Address object
The
Address object is used to represent an entity's address.JSON
{"street_1": "50 Bowling Green Dr","street_2": "Golden Gate Park","city": "San Francisco","state": "CA","postal_code": "94122","country": "USA","address_type": "Shipping","modified_at": "2021-10-16T00:00:00Z"}
Properties
street_1StringOptional
Line 1 of the address's street.
street_2StringOptional
Line 2 of the address's street.
cityStringOptional
The address's city.
stateStringOptional
The address's state.
postal_codeStringOptional
The address's postal code.
countryEnumOptional
The address's country. Possible values include:
AF, 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_typeEnumOptional
The address type. Possible values include:
BILLING, SHIPPING, or - in cases where there is no clear mapping - the original value passed through.modified_atStringRequired
This is the datetime that this object was last updated by Merge
phone_numbersPhoneNumber[]Required
The PhoneNumber object
The
PhoneNumber object is used to represent an entity's phone number.JSON
{"phone_number": "+3198675309","phone_number_type": "Mobile","modified_at": "2021-10-16T00:00:00Z"}
Properties
phone_numberStringOptional
The phone number.
phone_number_typeStringOptional
The phone number's type.
modified_atStringRequired
This is the datetime that this object was last updated by Merge
last_activity_atStringOptional
The last date (either most recent or furthest in the future) of when an activity occurs in an account.
remote_updated_atStringOptional
When the CRM system account data was last modified by a user with a login.
remote_created_atStringOptional
When the third party's account was created.
remote_was_deletedBooleanRequired
idStringRequired
remote_idStringOptional
The third-party API ID of the matching object.
field_mappingsObjectOptional
modified_atStringRequired
This is the datetime that this object was last updated by Merge
remote_dataRemoteData[]Optional
remote_fieldsRemoteField[]Required
The Account object
JSON
{"owner": "0258cbc6-6020-430a-848e-aafacbadf4ae","name": "Merge API","description": "One API for all integrations","industry": "API's","website": "https://merge.dev/","number_of_employees": 276000,"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"}],"phone_numbers": [{"phone_number": "+16788879833","phone_number_type": "Mobile"}],"last_activity_at": "2022-02-10T00:00:00Z","remote_updated_at": "2022-01-09T00:00:00Z","remote_created_at": "2021-11-10T00:00:00Z","remote_was_deleted": true,"id": "0958cbc6-6040-430a-848e-aafacbadf4ae","remote_id": "19202938",Show advanced fields}
GET
/accounts
Returns a list of Account objects.
Header Parameters
AuthorizationStringRequired
Token-based authentication with required prefix "Bearer"
X-Account-TokenStringRequired
Token identifying the end user.
Query & Path Parameters
created_afterStringOptional
If provided, will only return objects created after this datetime.
created_beforeStringOptional
If provided, will only return objects created before this datetime.
cursorStringOptional
The pagination cursor value.
expandStringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
include_deleted_dataBooleanOptional
Whether to include data that was marked as deleted by third party webhooks.
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_remote_fieldsBooleanOptional
Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
modified_afterStringOptional
If provided, only objects synced by Merge after this date time will be returned.
modified_beforeStringOptional
If provided, only objects synced by Merge before this date time will be returned.
owner_idStringOptional
If provided, will only return accounts with this owner.
page_sizeIntegerOptional
Number of results to return per page.
remote_idStringOptional
The API provider's ID for the given object.
Response
JSON
{"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw","previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ","results": [{"owner": "0258cbc6-6020-430a-848e-aafacbadf4ae","name": "Merge API","description": "One API for all integrations","industry": "API's","website": "https://merge.dev/","number_of_employees": 276000,"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"}],"phone_numbers": [{"phone_number": "+16788879833","phone_number_type": "Mobile"}],"last_activity_at": "2022-02-10T00:00:00Z","remote_updated_at": "2022-01-09T00:00:00Z","remote_created_at": "2021-11-10T00:00:00Z","remote_was_deleted": true,"id": "0958cbc6-6040-430a-848e-aafacbadf4ae","remote_id": "19202938",Show advanced fields}]}
Field support by platform
Accelo
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
addressesAddress[]street_1stringstreet_2stringcitystringstatestringpostal_codestringcountrystringaddress_typestringmodified_atstringdescriptionStringindustryStringlast_activity_atStringnameStringnumber_of_employeesIntegerownerStringphone_numbersPhoneNumber[]phone_numberstringphone_number_typestringmodified_atstringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringwebsiteString
ActiveCampaign
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
nameStringownerStringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringwebsiteString
Affinity
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
nameStringremote_dataRemoteData[]pathstringdataobjectremote_idStringwebsiteString
Capsule
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
descriptionStringlast_activity_atStringnameStringownerStringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringwebsiteString
Close
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
addressesAddress[]street_1stringstreet_2stringcitystringstatestringpostal_codestringcountrystringaddress_typestringmodified_atstringdescriptionStringnameStringphone_numbersPhoneNumber[]phone_numberstringphone_number_typestringmodified_atstringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringwebsiteString
Copper
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
addressesAddress[]street_1stringstreet_2stringcitystringstatestringpostal_codestringcountrystringaddress_typestringmodified_atstringdescriptionStringnameStringownerStringphone_numbersPhoneNumber[]phone_numberstringphone_number_typestringmodified_atstringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringwebsiteString
HubSpot
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
descriptionStringindustryStringlast_activity_atStringnameStringnumber_of_employeesIntegerownerStringphone_numbersPhoneNumber[]phone_numberstringphone_number_typestringmodified_atstringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_fieldsRemoteField[]remote_field_classobjectvalueobjectremote_idStringremote_updated_atStringwebsiteString
Insightly
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
addressesAddress[]street_1stringstreet_2stringcitystringstatestringpostal_codestringcountrystringaddress_typestringmodified_atstringlast_activity_atStringnameStringownerStringphone_numbersPhoneNumber[]phone_numberstringphone_number_typestringmodified_atstringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringwebsiteString
Keap
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
addressesAddress[]street_1stringstreet_2stringcitystringstatestringpostal_codestringcountrystringaddress_typestringmodified_atstringnameStringphone_numbersPhoneNumber[]phone_numberstringphone_number_typestringmodified_atstringremote_dataRemoteData[]pathstringdataobjectremote_idStringwebsiteString
Microsoft Dynamics 365 Sales
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
addressesAddress[]street_1stringstreet_2stringcitystringstatestringpostal_codestringcountrystringaddress_typestringmodified_atstringdescriptionStringnameStringnumber_of_employeesIntegerownerStringphone_numbersPhoneNumber[]phone_numberstringphone_number_typestringmodified_atstringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringwebsiteString
Nutshell
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
addressesAddress[]street_1stringstreet_2stringcitystringstatestringpostal_codestringcountrystringaddress_typestringmodified_atstringdescriptionStringindustryStringnameStringownerStringphone_numbersPhoneNumber[]phone_numberstringphone_number_typestringmodified_atstringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringwebsiteString
Pipedrive
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
last_activity_atStringnameStringnumber_of_employeesIntegerownerStringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_fieldsRemoteField[]remote_field_classobjectvalueobjectremote_idStringremote_updated_atString
Pipeliner
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
descriptionStringindustryStringnameStringownerStringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringwebsiteString
Salesflare
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
addressesAddress[]street_1stringstreet_2stringcitystringstatestringpostal_codestringcountrystringaddress_typestringmodified_atstringdescriptionStringlast_activity_atStringnameStringnumber_of_employeesIntegerownerStringphone_numbersPhoneNumber[]phone_numberstringphone_number_typestringmodified_atstringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringwebsiteString
Salesforce
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
descriptionStringindustryStringlast_activity_atStringnameStringnumber_of_employeesIntegerownerStringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_fieldsRemoteField[]remote_field_classobjectvalueobjectremote_idStringremote_updated_atStringwebsiteString
SugarCRM
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
addressesAddress[]street_1stringstreet_2stringcitystringstatestringpostal_codestringcountrystringaddress_typestringmodified_atstringdescriptionStringindustryStringnameStringnumber_of_employeesIntegerownerStringphone_numbersPhoneNumber[]phone_numberstringphone_number_typestringmodified_atstringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringwebsiteString
Teamleader
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
addressesAddress[]street_1stringstreet_2stringcitystringstatestringpostal_codestringcountrystringaddress_typestringmodified_atstringnameStringownerStringphone_numbersPhoneNumber[]phone_numberstringphone_number_typestringmodified_atstringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringwebsiteString
Teamwork CRM
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
addressesAddress[]street_1stringstreet_2stringcitystringstatestringpostal_codestringcountrystringaddress_typestringmodified_atstringnameStringownerStringphone_numbersPhoneNumber[]phone_numberstringphone_number_typestringmodified_atstringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringwebsiteString
Vtiger
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
descriptionStringindustryStringlast_activity_atStringnameStringnumber_of_employeesIntegerphone_numbersPhoneNumber[]phone_numberstringphone_number_typestringmodified_atstringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringwebsiteString
Zendesk Sell
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
addressesAddress[]street_1stringstreet_2stringcitystringstatestringpostal_codestringcountrystringaddress_typestringmodified_atstringdescriptionStringindustryStringnameStringownerStringphone_numbersPhoneNumber[]phone_numberstringphone_number_typestringmodified_atstringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringwebsiteString
Zoho CRM
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
addressesAddress[]street_1stringstreet_2stringcitystringstatestringpostal_codestringcountrystringaddress_typestringmodified_atstringdescriptionStringindustryStringlast_activity_atStringnameStringnumber_of_employeesIntegerownerStringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringwebsiteStringHint: Use the /linked-accounts endpoint to pull platform support information.
POST
/accounts
Creates an Account object with the given values.
Header Parameters
AuthorizationStringRequired
Token-based authentication with required prefix "Bearer"
X-Account-TokenStringRequired
Token identifying the end user.
Query & Path Parameters
is_debug_modeBooleanOptional
Whether to include debug fields (such as log file links) in the response.
run_asyncBooleanOptional
Whether or not third-party updates should be run asynchronously.
Body Parameters
modelObjectRequired
Find available fields below under “Model Parameters”.
Model Parameters
View app-specific writable fields under “Field support by platform” in this section.ownerStringThe account's owner. Must pass in a valid Merge ID, which can be obtained from the
id field in the User object.nameStringThe account's name.
descriptionStringThe account's description.
industryStringThe account's industry.
websiteStringThe account's website.
number_of_employeesIntegerThe account's number of employees.
last_activity_atStringThe last date (either most recent or furthest in the future) of when an activity occurs in an account.
integration_paramsObjectlinked_account_paramsObjectremote_fieldsArrayPOST v1/accounts
JSON
{"model": {"owner": "0258cbc6-6020-430a-848e-aafacbadf4ae","name": "Merge API","description": "One API for all integrations","industry": "API's","website": "https://merge.dev/","number_of_employees": 276000,"last_activity_at": "2022-02-10T00:00:00Z"}}
Response
JSON
{"model": {"owner": "0258cbc6-6020-430a-848e-aafacbadf4ae","name": "Merge API","description": "One API for all integrations","industry": "API's","website": "https://merge.dev/","number_of_employees": 276000,"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"}],"phone_numbers": [{"phone_number": "+16788879833","phone_number_type": "Mobile"}],"last_activity_at": "2022-02-10T00:00:00Z","remote_updated_at": "2022-01-09T00:00:00Z","remote_created_at": "2021-11-10T00:00:00Z","remote_was_deleted": true,"id": "0958cbc6-6040-430a-848e-aafacbadf4ae","remote_id": "19202938",Show advanced fields}}
Field support by platform
Capsule
Merge supports Passthrough Requests to this platform's API
Supported POST Model Parameters
descriptionStringOptional
last_activity_atStringOptional
nameStringOptional
ownerStringOptional
remote_created_atStringOptional
remote_idStringOptional
remote_updated_atStringOptional
websiteStringOptional
Close
Merge supports Passthrough Requests to this platform's API
Supported POST Model Parameters
addressesAddress[]street_1stringstreet_2stringcitystringstatestringpostal_codestringcountrystringaddress_typestringmodified_atstringdescriptionStringOptional
nameStringOptional
phone_numbersPhoneNumber[]phone_numberstringphone_number_typestringmodified_atstringremote_created_atStringOptional
remote_idStringOptional
remote_updated_atStringOptional
websiteStringOptional
Copper
Merge supports Passthrough Requests to this platform's API
Supported POST Model Parameters
addressesAddress[]street_1stringstreet_2stringcitystringstatestringpostal_codestringcountrystringaddress_typestringmodified_atstringdescriptionStringOptional
nameStringOptional
ownerStringOptional
phone_numbersPhoneNumber[]phone_numberstringphone_number_typestringmodified_atstringremote_created_atStringOptional
remote_idStringOptional
remote_updated_atStringOptional
websiteStringOptional
HubSpot
Merge supports Passthrough Requests to this platform's API
Supported POST Model Parameters
descriptionStringOptional
industryStringOptional
last_activity_atStringOptional
nameStringOptional
number_of_employeesIntegerOptional
ownerStringOptional
phone_numbersPhoneNumber[]phone_numberstringphone_number_typestringmodified_atstringremote_created_atStringOptional
remote_fieldsRemoteField[]remote_field_classobjectvalueobjectremote_idStringOptional
remote_updated_atStringOptional
websiteStringOptional
Pipedrive
Merge supports Passthrough Requests to this platform's API
Supported POST Model Parameters
addressesAddress[]street_1stringstreet_2stringcitystringstatestringpostal_codestringcountrystringaddress_typestringmodified_atstringlast_activity_atStringOptional
nameStringRequired
number_of_employeesIntegerOptional
ownerStringOptional
remote_created_atStringOptional
remote_fieldsRemoteField[]remote_field_classobjectvalueobjectremote_idStringOptional
remote_updated_atStringOptional
Salesforce
Merge supports Passthrough Requests to this platform's API
Supported POST Model Parameters
addressesAddress[]street_1stringstreet_2stringcitystringstatestringpostal_codestringcountrystringaddress_typestringmodified_atstringdescriptionStringOptional
industryStringOptional
last_activity_atStringOptional
nameStringRequired
number_of_employeesIntegerOptional
ownerStringOptional
phone_numbersPhoneNumber[]phone_numberstringphone_number_typestringmodified_atstringremote_created_atStringOptional
remote_fieldsRemoteField[]remote_field_classobjectvalueobjectremote_idStringOptional
remote_updated_atStringOptional
websiteStringOptional
Zendesk Sell
Merge supports Passthrough Requests to this platform's API
Supported POST Model Parameters
addressesAddress[]street_1stringstreet_2stringcitystringstatestringpostal_codestringcountrystringaddress_typestringmodified_atstringdescriptionStringOptional
industryStringOptional
nameStringOptional
ownerStringOptional
phone_numbersPhoneNumber[]phone_numberstringphone_number_typestringmodified_atstringremote_created_atStringOptional
remote_idStringOptional
remote_updated_atStringOptional
websiteStringOptional
Zoho CRM
Merge supports Passthrough Requests to this platform's API
Supported POST Model Parameters
descriptionStringOptional
industryStringOptional
last_activity_atStringOptional
nameStringOptional
number_of_employeesIntegerOptional
ownerStringOptional
remote_created_atStringOptional
remote_idStringOptional
remote_updated_atStringOptional
websiteStringOptional
Hint: Use the /linked-accounts endpoint to pull platform support information.
GET
/accounts/{id}
Returns an Account object with the given id.
Header Parameters
AuthorizationStringRequired
Token-based authentication with required prefix "Bearer"
X-Account-TokenStringRequired
Token identifying the end user.
Query & Path Parameters
expandStringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
idStringRequired
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_remote_fieldsBooleanOptional
Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
Response
JSON
{"owner": "0258cbc6-6020-430a-848e-aafacbadf4ae","name": "Merge API","description": "One API for all integrations","industry": "API's","website": "https://merge.dev/","number_of_employees": 276000,"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"}],"phone_numbers": [{"phone_number": "+16788879833","phone_number_type": "Mobile"}],"last_activity_at": "2022-02-10T00:00:00Z","remote_updated_at"