Accounts

The Account object is used to represent an account in the remote system.

The Account object

Properties

idString

Required

remote_idString

Optional

The third-party API ID of the matching object.

ownerString

Optional

nameString

Optional

The account's name.

descriptionString

Optional

The account's description.

industryString

Optional

The account's industry.

websiteString

Optional

The account's website.

number_of_employeesInteger

Optional

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"
}

Properties

street_1String

Optional

Line 1 of the address's street.

street_2String

Optional

Line 2 of the address's street.

cityString

Optional

The address's city.

stateString

Optional

The address's state.

postal_codeString

Optional

The address's postal code.

countryEnum

Optional

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_typeEnum

Optional

The address type. Possible values include: BILLING, SHIPPING, or - in cases where there is no clear mapping - the original value passed through.

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"
}

Properties

phone_numberString

Optional

The phone number.

phone_number_typeString

Optional

The phone number's type.

last_activity_atString

Optional

When the account's last activity occurred.

remote_updated_atString

Optional

When the third party's account was updated.

remote_created_atString

Optional

When the third party's account was created.

remote_dataRemoteData[]

Optional

remote_was_deletedBoolean

Required

The Account object

JSON


{
  "id": "0958cbc6-6040-430a-848e-aafacbadf4ae",
  "remote_id": "19202938",
  "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_data": [
    {
      "path": "/accounts",
      "data": [
        "Varies by platform"
      ]
    }
  ],
  "remote_was_deleted": true
}

GET

/accounts

Returns a list of Account objects.

Header Parameters

AuthorizationString

Required

Token-based authentication with required prefix "Bearer"

X-Account-TokenString

Required

Token identifying the end user.

Query & Path Parameters

created_afterString

Optional

If provided, will only return objects created after this datetime.

created_beforeString

Optional

If provided, will only return objects created before this datetime.

cursorString

Optional

The pagination cursor value.

expandString

Optional

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

include_deleted_dataBoolean

Optional

Whether to include data that was marked as deleted by third party webhooks.

include_remote_dataBoolean

Optional

Whether to include the original data Merge fetched from the third-party to produce these models.

modified_afterString

Optional

If provided, will only return objects modified after this datetime.

modified_beforeString

Optional

If provided, will only return objects modified before this datetime.

owner_idString

Optional

If provided, will only return accounts with this owner.

page_sizeInteger

Optional

Number of results to return per page.

remote_idString

Optional

The API provider's ID for the given object.

Response

JSON


{
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
  "previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
  "results": [
    {
      "id": "0958cbc6-6040-430a-848e-aafacbadf4ae",
      "remote_id": "19202938",
      "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_data": [
        {
          "path": "/accounts",
          "data": [
            "Varies by platform"
          ]
        }
      ],
      "remote_was_deleted": true
    }
  ]
}

Field support by platform

ActiveCampaign

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

ownerString

remote_created_atString

remote_dataRemoteData[]

remote_idString

remote_updated_atString

websiteString

Capsule

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

descriptionString

last_activity_atString

nameString

ownerString

remote_created_atString

remote_dataRemoteData[]

remote_idString

remote_updated_atString

websiteString

Close

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

addressesAddress[]

descriptionString

nameString

remote_created_atString

remote_dataRemoteData[]

remote_idString

remote_updated_atString

websiteString

Copper

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

descriptionString

nameString

ownerString

remote_created_atString

remote_dataRemoteData[]

remote_idString

remote_updated_atString

websiteString

HubSpot

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

descriptionString

industryString

last_activity_atString

nameString

number_of_employeesInteger

ownerString

remote_created_atString

remote_dataRemoteData[]

remote_idString

remote_updated_atString

websiteString

Pipedrive

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

last_activity_atString

nameString

number_of_employeesInteger

ownerString

remote_created_atString

remote_dataRemoteData[]

remote_idString

remote_updated_atString

Salesflare

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

addressesAddress[]

descriptionString

last_activity_atString

nameString

number_of_employeesInteger

ownerString

phone_numbersPhoneNumber[]

remote_created_atString

remote_dataRemoteData[]

remote_idString

remote_updated_atString

websiteString

Salesforce

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

descriptionString

industryString

last_activity_atString

nameString

number_of_employeesInteger

ownerString

remote_created_atString

remote_dataRemoteData[]

remote_idString

remote_updated_atString

websiteString

Teamleader

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

addressesAddress[]

nameString

ownerString

phone_numbersPhoneNumber[]

remote_created_atString

remote_dataRemoteData[]

remote_idString

remote_updated_atString

websiteString

Teamwork CRM

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

addressesAddress[]

nameString

ownerString

phone_numbersPhoneNumber[]

remote_created_atString

remote_dataRemoteData[]

remote_idString

remote_updated_atString

websiteString

Zendesk Sell

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

addressesAddress[]

descriptionString

industryString

nameString

ownerString

phone_numbersPhoneNumber[]

remote_created_atString

remote_dataRemoteData[]

remote_idString

remote_updated_atString

websiteString

Zoho CRM

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

addressesAddress[]

descriptionString

industryString

last_activity_atString

nameString

number_of_employeesInteger

ownerString

remote_created_atString

remote_dataRemoteData[]

remote_idString

remote_updated_atString

websiteString

Not seeing a platform that you're looking for? Submit a request for it here.

Hint: Use the /linked-accounts endpoint to pull platform support information.

POST

/accounts

Creates an Account object with the given values.

Header Parameters

AuthorizationString

Required

Token-based authentication with required prefix "Bearer"

X-Account-TokenString

Required

Token identifying the end user.

Query & Path Parameters

is_debug_modeBoolean

Optional

Whether to include debug fields (such as log file links) in the response.

run_asyncBoolean

Optional

Whether or not third-party updates should be run asynchronously.

Body Parameters

modelObject

Required

Find available fields below under “Model Parameters”.

Model Parameters

remote_idString

Optional

The third-party API ID of the matching object.

ownerString

Optional

Must pass in a valid Merge ID, which can be obtained from the id field in the Owner table.

nameString

Optional

The account's name.

descriptionString

Optional

The account's description.

industryString

Optional

The account's industry.

websiteString

Optional

The account's website.

number_of_employeesInteger

Optional

The account's number of employees.

last_activity_atString

Optional

When the account's last activity occurred.

remote_updated_atString

Optional

When the third party's account was updated.

remote_created_atString

Optional

When the third party's account was created.

integration_paramsObject

Optional

linked_account_paramsObject

Optional

Response

JSON


{
  "model": {
    "id": "0958cbc6-6040-430a-848e-aafacbadf4ae",
    "remote_id": "19202938",
    "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_data": [
      {
        "path": "/accounts",
        "data": [
          "Varies by platform"
        ]
      }
    ],
    "remote_was_deleted": true
  },
  "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
      }
    }
  ]
}

GET

/accounts/{id}

Returns an Account object with the given id.

Header Parameters

AuthorizationString

Required

Token-based authentication with required prefix "Bearer"

X-Account-TokenString

Required

Token identifying the end user.

Query & Path Parameters

expandString

Optional

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

idString

Required

include_remote_dataBoolean

Optional

Whether to include the original data Merge fetched from the third-party to produce these models.

Response

JSON


{
  "id": "0958cbc6-6040-430a-848e-aafacbadf4ae",
  "remote_id": "19202938",
  "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_data": [
    {
      "path": "/accounts",
      "data": [
        "Varies by platform"
      ]
    }
  ],
  "remote_was_deleted": true
}

Field support by platform

ActiveCampaign

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

ownerString

remote_created_atString

remote_dataRemoteData[]

remote_idString

remote_updated_atString

websiteString

Capsule

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

descriptionString

last_activity_atString

nameString

ownerString

remote_created_atString

remote_dataRemoteData[]

remote_idString

remote_updated_atString

websiteString

Close

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

addressesAddress[]

descriptionString

nameString

remote_created_atString

remote_dataRemoteData[]

remote_idString

remote_updated_atString

websiteString

Copper

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

descriptionString

nameString

ownerString

remote_created_atString

remote_dataRemoteData[]

remote_idString

remote_updated_atString

websiteString

HubSpot

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

descriptionString

industryString

last_activity_atString

nameString

number_of_employeesInteger

ownerString

remote_created_atString

remote_dataRemoteData[]

remote_idString

remote_updated_atString

websiteString

Pipedrive

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

last_activity_atString

nameString

number_of_employeesInteger

ownerString

remote_created_atString

remote_dataRemoteData[]

remote_idString

remote_updated_atString

Salesflare

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

addressesAddress[]

descriptionString

last_activity_atString

nameString

number_of_employeesInteger

ownerString

phone_numbersPhoneNumber[]

remote_created_atString

remote_dataRemoteData[]

remote_idString

remote_updated_atString

websiteString

Salesforce

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

descriptionString

industryString

last_activity_atString

nameString

number_of_employeesInteger

ownerString

remote_created_atString

remote_dataRemoteData[]

remote_idString

remote_updated_atString

websiteString

Teamleader

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

addressesAddress[]

nameString

ownerString

phone_numbersPhoneNumber[]

remote_created_atString

remote_dataRemoteData[]

remote_idString

remote_updated_atString

websiteString

Teamwork CRM

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

addressesAddress[]

nameString

ownerString

phone_numbersPhoneNumber[]

remote_created_atString

remote_dataRemoteData[]

remote_idString

remote_updated_atString

websiteString

Zendesk Sell

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

addressesAddress[]

descriptionString

industryString

nameString

ownerString

phone_numbersPhoneNumber[]

remote_created_atString

remote_dataRemoteData[]

remote_idString

remote_updated_atString

websiteString

Zoho CRM

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

addressesAddress[]

descriptionString

industryString

last_activity_atString

nameString

number_of_employeesInteger

ownerString

remote_created_atString

remote_dataRemoteData[]

remote_idString

remote_updated_atString

websiteString

Not seeing a platform that you're looking for? Submit a request for it here.

Hint: Use the /linked-accounts endpoint to pull platform support information.

GET

/accounts/meta/post

Returns metadata for CRMAccount POSTs.

Header Parameters

AuthorizationString

Required

Token-based authentication with required prefix "Bearer"

X-Account-TokenString

Required

Token identifying the end user.

Response

JSON


{
  "request_schema": {},
  "status": {
    "linked_account_status": "string",
    "can_make_request": true
  },
  "has_conditional_params": true,
  "has_required_linked_account_params": true
}

Field support by platform

ActiveCampaign

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

ownerString

remote_created_atString

remote_dataRemoteData[]

remote_idString

remote_updated_atString

websiteString

Capsule

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

descriptionString

last_activity_atString

nameString

ownerString

remote_created_atString

remote_dataRemoteData[]

remote_idString

remote_updated_atString

websiteString

Close

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

addressesAddress[]

descriptionString

nameString

remote_created_atString

remote_dataRemoteData[]

remote_idString

remote_updated_atString

websiteString

Copper

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

descriptionString

nameString

ownerString

remote_created_atString

remote_dataRemoteData[]

remote_idString

remote_updated_atString

websiteString

HubSpot

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

descriptionString

industryString

last_activity_atString

nameString

number_of_employeesInteger

ownerString

remote_created_atString

remote_dataRemoteData[]

remote_idString

remote_updated_atString

websiteString

Pipedrive

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

last_activity_atString

nameString

number_of_employeesInteger

ownerString

remote_created_atString

remote_dataRemoteData[]

remote_idString

remote_updated_atString

Salesflare

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

addressesAddress[]

descriptionString

last_activity_atString

nameString

number_of_employeesInteger

ownerString

phone_numbersPhoneNumber[]

remote_created_atString

remote_dataRemoteData[]

remote_idString

remote_updated_atString

websiteString

Salesforce

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

descriptionString

industryString

last_activity_atString

nameString

number_of_employeesInteger

ownerString

remote_created_atString

remote_dataRemoteData[]

remote_idString

remote_updated_atString

websiteString

Teamleader

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

addressesAddress[]

nameString

ownerString

phone_numbersPhoneNumber[]

remote_created_atString

remote_dataRemoteData[]

remote_idString

remote_updated_atString

websiteString

Teamwork CRM

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

addressesAddress[]

nameString

ownerString

phone_numbersPhoneNumber[]

remote_created_atString

remote_dataRemoteData[]

remote_idString

remote_updated_atString

websiteString

Zendesk Sell

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

addressesAddress[]

descriptionString

industryString

nameString

ownerString

phone_numbersPhoneNumber[]

remote_created_atString

remote_dataRemoteData[]

remote_idString

remote_updated_atString

websiteString

Zoho CRM

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

addressesAddress[]

descriptionString

industryString

last_activity_atString

nameString

number_of_employeesInteger

ownerString

remote_created_atString

remote_dataRemoteData[]

remote_idString

remote_updated_atString

websiteString

Not seeing a platform that you're looking for? Submit a request for it here.

Hint: Use the /linked-accounts endpoint to pull platform support information.

Overview

Next Up

Contacts

Accounts

The Account object

Properties

The Address object

Properties

The PhoneNumber object

Properties

/accounts

Header Parameters

Query & Path Parameters

ActiveCampaign

Capsule

Close

Copper

HubSpot

Pipedrive

Salesflare

Salesforce

Teamleader

Teamwork CRM

Zendesk Sell

Zoho CRM

/accounts

Header Parameters

Query & Path Parameters

Body Parameters

Model Parameters

/accounts/{id}

Header Parameters

Query & Path Parameters

ActiveCampaign

Capsule

Close

Copper

HubSpot

Pipedrive

Salesflare

Salesforce

Teamleader

Teamwork CRM

Zendesk Sell

Zoho CRM

/accounts/meta/post

Header Parameters

ActiveCampaign

Capsule

Close

Copper

HubSpot

Pipedrive

Salesflare

Salesforce

Teamleader

Teamwork CRM

Zendesk Sell

Zoho CRM

Previous

Next Up

Get Started

API Reference