/contacts

import { MergeClient } from "@mergeapi/merge-node-client";
const client = new MergeClient({ apiKey: "YOUR_API_KEY", accountToken: "YOUR_ACCOUNT_TOKEN" });
const pageableResponse = await client.crm.contacts.list({
    accountId: "account_id",
    createdAfter: new Date("2024-01-15T09:30:00.000Z"),
    createdBefore: new Date("2024-01-15T09:30:00.000Z"),
    cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
    emailAddresses: "email_addresses",
    includeDeletedData: true,
    includeRemoteData: true,
    includeRemoteFields: true,
    includeShellData: true,
    modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
    modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
    pageSize: 1,
    phoneNumbers: "phone_numbers",
    remoteId: "remote_id"
});
for await (const item of pageableResponse) {
    console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.crm.contacts.list({
    accountId: "account_id",
    createdAfter: new Date("2024-01-15T09:30:00.000Z"),
    createdBefore: new Date("2024-01-15T09:30:00.000Z"),
    cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
    emailAddresses: "email_addresses",
    includeDeletedData: true,
    includeRemoteData: true,
    includeRemoteFields: true,
    includeShellData: true,
    modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
    modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
    pageSize: 1,
    phoneNumbers: "phone_numbers",
    remoteId: "remote_id"
});
while (page.hasNextPage()) {
    page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;

{
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
  "previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
  "results": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "remote_id": "19202938",
      "created_at": "2021-09-15T00:00:00Z",
      "modified_at": "2021-10-16T00:00:00Z",
      "first_name": "Gil",
      "last_name": "Feig",
      "account": "0958cbc6-6040-430a-848e-aafacbadf4ae",
      "owner": "b8fbfc30-0982-420e-8c20-dab07b70b9d6",
      "addresses": [
        {
          "created_at": "2021-09-15T00:00:00Z",
          "modified_at": "2021-10-16T00:00:00Z",
          "street_1": "50 Bowling Green Dr",
          "street_2": "Golden Gate Park",
          "city": "San Francisco",
          "state": "CA",
          "postal_code": "94122",
          "country": "US",
          "address_type": "BILLING"
        }
      ],
      "email_addresses": [
        {
          "email_address": "hello@merge.dev",
          "email_address_type": "Work"
        }
      ],
      "phone_numbers": [
        {
          "created_at": "2021-09-15T00:00:00Z",
          "modified_at": "2021-10-16T00:00:00Z",
          "phone_number": "+13785579223",
          "phone_number_type": "Mobile"
        }
      ],
      "last_activity_at": "2022-02-10T00:00:00Z",
      "remote_created_at": "2021-11-10T00:00:00Z",
      "remote_was_deleted": true,
      "field_mappings": {
        "organization_defined_targets": {
          "custom_key": "custom_value"
        },
        "linked_account_defined_targets": {
          "custom_key": "custom_value"
        }
      },
      "remote_data": [
        {
          "path": "/contacts"
        }
      ],
      "remote_fields": [
        {
          "remote_field_class": {
            "id": "string",
            "display_name": "string",
            "remote_key_name": "string",
            "description": "string",
            "is_custom": true,
            "is_common_model_field": true,
            "is_required": true,
            "field_type": "string",
            "field_format": "string",
            "field_choices": [
              "string"
            ],
            "item_schema": {
              "item_type": "string",
              "item_format": "string",
              "item_choices": [
                "string"
              ]
            }
          },
          "value": "string"
        }
      ]
    }
  ]
}

Returns a list of Contact objects.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Query parameters

account_idstringOptional

If provided, will only return contacts with this account.

created_afterdatetimeOptional

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

created_beforedatetimeOptional

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

cursorstringOptional

The pagination cursor value.

email_addressesstringOptional

If provided, will only return contacts matching the email addresses; multiple email_addresses can be separated by commas.

expandenumOptional

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

Allowed values:

include_deleted_databooleanOptional

Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.

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.

include_shell_databooleanOptional

Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

modified_afterdatetimeOptional

If provided, only objects synced by Merge after this date time will be returned.

modified_beforedatetimeOptional

If provided, only objects synced by Merge before this date time will be returned.

page_sizeintegerOptional

Number of results to return per page. The maximum limit is 100.

phone_numbersstringOptional

If provided, will only return contacts matching the phone numbers; multiple phone numbers can be separated by commas.

remote_idstringOptional

The API provider's ID for the given object.

Response

nextstring or null

previousstring or null

resultslist of objects or null

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional

The contact's first name.

last_namestring or nullOptional

The contact's last name.

accountstring or nullOptionalformat: "uuid"

The contact's account.

email_addresseslist of objectsOptional

phone_numberslist of objectsOptional

last_activity_atdatetime or nullOptional

When the contact's last activity occurred.

remote_created_atdatetime or nullOptional

When the third party's contact was created.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional

The contact's first name.

last_namestring or nullOptional

The contact's last name.

accountstring or nullOptionalformat: "uuid"

The contact's account.

email_addresseslist of objectsOptional

phone_numberslist of objectsOptional

last_activity_atdatetime or nullOptional

When the contact's last activity occurred.

remote_created_atdatetime or nullOptional

When the third party's contact was created.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional

The contact's first name.

last_namestring or nullOptional

The contact's last name.

accountstring or nullOptionalformat: "uuid"

The contact's account.

email_addresseslist of objectsOptional

phone_numberslist of objectsOptional

remote_created_atdatetime or nullOptional

When the third party's contact was created.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional

The contact's first name.

last_namestring or nullOptional

The contact's last name.

accountstring or nullOptionalformat: "uuid"

The contact's account.

addresseslist of objectsOptional

email_addresseslist of objectsOptional

phone_numberslist of objectsOptional

last_activity_atdatetime or nullOptional

When the contact's last activity occurred.

remote_created_atdatetime or nullOptional

When the third party's contact was created.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional

The contact's first name.

last_namestring or nullOptional

The contact's last name.

accountstring or nullOptionalformat: "uuid"

The contact's account.

ownerstring or nullOptionalformat: "uuid"

The contact's owner.

addresseslist of objectsOptional

email_addresseslist of objectsOptional

phone_numberslist of objectsOptional

last_activity_atdatetime or nullOptional

When the contact's last activity occurred.

remote_created_atdatetime or nullOptional

When the third party's contact was created.

remote_datalist of objects or nullOptionalRead-only

remote_fieldslist of objectsOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional

The contact's first name.

last_namestring or nullOptional

The contact's last name.

accountstring or nullOptionalformat: "uuid"

The contact's account.

email_addresseslist of objectsOptional

phone_numberslist of objectsOptional

remote_created_atdatetime or nullOptional

When the third party's contact was created.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional

The contact's first name.

last_namestring or nullOptional

The contact's last name.

accountstring or nullOptionalformat: "uuid"

The contact's account.

addresseslist of objectsOptional

email_addresseslist of objectsOptional

phone_numberslist of objectsOptional

remote_created_atdatetime or nullOptional

When the third party's contact was created.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional

The contact's first name.

last_namestring or nullOptional

The contact's last name.

accountstring or nullOptionalformat: "uuid"

The contact's account.

ownerstring or nullOptionalformat: "uuid"

The contact's owner.

addresseslist of objectsOptional

email_addresseslist of objectsOptional

phone_numberslist of objectsOptional

remote_created_atdatetime or nullOptional

When the third party's contact was created.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional

The contact's first name.

last_namestring or nullOptional

The contact's last name.

accountstring or nullOptionalformat: "uuid"

The contact's account.

addresseslist of objectsOptional

email_addresseslist of objectsOptional

phone_numberslist of objectsOptional

last_activity_atdatetime or nullOptional

When the contact's last activity occurred.

remote_created_atdatetime or nullOptional

When the third party's contact was created.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional

The contact's first name.

last_namestring or nullOptional

The contact's last name.

accountstring or nullOptionalformat: "uuid"

The contact's account.

ownerstring or nullOptionalformat: "uuid"

The contact's owner.

addresseslist of objectsOptional

email_addresseslist of objectsOptional

phone_numberslist of objectsOptional

last_activity_atdatetime or nullOptional

When the contact's last activity occurred.

remote_created_atdatetime or nullOptional

When the third party's contact was created.

remote_datalist of objects or nullOptionalRead-only

remote_fieldslist of objectsOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional

The contact's first name.

last_namestring or nullOptional

The contact's last name.

accountstring or nullOptionalformat: "uuid"

The contact's account.

addresseslist of objectsOptional

email_addresseslist of objectsOptional

phone_numberslist of objectsOptional

remote_created_atdatetime or nullOptional

When the third party's contact was created.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional

The contact's first name.

last_namestring or nullOptional

The contact's last name.

accountstring or nullOptionalformat: "uuid"

The contact's account.

ownerstring or nullOptionalformat: "uuid"

The contact's owner.

addresseslist of objectsOptional

email_addresseslist of objectsOptional

phone_numberslist of objectsOptional

last_activity_atdatetime or nullOptional

When the contact's last activity occurred.

remote_created_atdatetime or nullOptional

When the third party's contact was created.

remote_datalist of objects or nullOptionalRead-only

remote_fieldslist of objectsOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional

The contact's first name.

last_namestring or nullOptional

The contact's last name.

accountstring or nullOptionalformat: "uuid"

The contact's account.

addresseslist of objectsOptional

email_addresseslist of objectsOptional

phone_numberslist of objectsOptional

remote_created_atdatetime or nullOptional

When the third party's contact was created.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional

The contact's first name.

last_namestring or nullOptional

The contact's last name.

accountstring or nullOptionalformat: "uuid"

The contact's account.

addresseslist of objectsOptional

email_addresseslist of objectsOptional

phone_numberslist of objectsOptional

remote_created_atdatetime or nullOptional

When the third party's contact was created.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional

The contact's first name.

last_namestring or nullOptional

The contact's last name.

accountstring or nullOptionalformat: "uuid"

The contact's account.

email_addresseslist of objectsOptional

phone_numberslist of objectsOptional

last_activity_atdatetime or nullOptional

When the contact's last activity occurred.

remote_created_atdatetime or nullOptional

When the third party's contact was created.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional

The contact's first name.

last_namestring or nullOptional

The contact's last name.

accountstring or nullOptionalformat: "uuid"

The contact's account.

addresseslist of objectsOptional

email_addresseslist of objectsOptional

phone_numberslist of objectsOptional

remote_created_atdatetime or nullOptional

When the third party's contact was created.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional

The contact's first name.

last_namestring or nullOptional

The contact's last name.

accountstring or nullOptionalformat: "uuid"

The contact's account.

ownerstring or nullOptionalformat: "uuid"

The contact's owner.

addresseslist of objectsOptional

email_addresseslist of objectsOptional

phone_numberslist of objectsOptional

last_activity_atdatetime or nullOptional

When the contact's last activity occurred.

remote_created_atdatetime or nullOptional

When the third party's contact was created.

remote_datalist of objects or nullOptionalRead-only

remote_fieldslist of objectsOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional

The contact's first name.

last_namestring or nullOptional

The contact's last name.

accountstring or nullOptionalformat: "uuid"

The contact's account.

email_addresseslist of objectsOptional

phone_numberslist of objectsOptional

last_activity_atdatetime or nullOptional

When the contact's last activity occurred.

remote_created_atdatetime or nullOptional

When the third party's contact was created.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional

The contact's first name.

last_namestring or nullOptional

The contact's last name.

accountstring or nullOptionalformat: "uuid"

The contact's account.

email_addresseslist of objectsOptional

phone_numberslist of objectsOptional

last_activity_atdatetime or nullOptional

When the contact's last activity occurred.

remote_created_atdatetime or nullOptional

When the third party's contact was created.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional

The contact's first name.

last_namestring or nullOptional

The contact's last name.

accountstring or nullOptionalformat: "uuid"

The contact's account.

email_addresseslist of objectsOptional

phone_numberslist of objectsOptional

remote_created_atdatetime or nullOptional

When the third party's contact was created.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional

The contact's first name.

last_namestring or nullOptional

The contact's last name.

accountstring or nullOptionalformat: "uuid"

The contact's account.

addresseslist of objectsOptional

email_addresseslist of objectsOptional

phone_numberslist of objectsOptional

last_activity_atdatetime or nullOptional

When the contact's last activity occurred.

remote_created_atdatetime or nullOptional

When the third party's contact was created.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional

The contact's first name.

last_namestring or nullOptional

The contact's last name.

accountstring or nullOptionalformat: "uuid"

The contact's account.

ownerstring or nullOptionalformat: "uuid"

The contact's owner.

addresseslist of objectsOptional

email_addresseslist of objectsOptional

phone_numberslist of objectsOptional

last_activity_atdatetime or nullOptional

When the contact's last activity occurred.

remote_created_atdatetime or nullOptional

When the third party's contact was created.

remote_datalist of objects or nullOptionalRead-only

remote_fieldslist of objectsOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional

The contact's first name.

last_namestring or nullOptional

The contact's last name.

accountstring or nullOptionalformat: "uuid"

The contact's account.

email_addresseslist of objectsOptional

phone_numberslist of objectsOptional

remote_created_atdatetime or nullOptional

When the third party's contact was created.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional

The contact's first name.

last_namestring or nullOptional

The contact's last name.

accountstring or nullOptionalformat: "uuid"

The contact's account.

addresseslist of objectsOptional

email_addresseslist of objectsOptional

phone_numberslist of objectsOptional

remote_created_atdatetime or nullOptional

When the third party's contact was created.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional

The contact's first name.

last_namestring or nullOptional

The contact's last name.

accountstring or nullOptionalformat: "uuid"

The contact's account.

ownerstring or nullOptionalformat: "uuid"

The contact's owner.

addresseslist of objectsOptional

email_addresseslist of objectsOptional

phone_numberslist of objectsOptional

remote_created_atdatetime or nullOptional

When the third party's contact was created.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional

The contact's first name.

last_namestring or nullOptional

The contact's last name.

accountstring or nullOptionalformat: "uuid"

The contact's account.

addresseslist of objectsOptional

email_addresseslist of objectsOptional

phone_numberslist of objectsOptional

last_activity_atdatetime or nullOptional

When the contact's last activity occurred.

remote_created_atdatetime or nullOptional

When the third party's contact was created.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional

The contact's first name.

last_namestring or nullOptional

The contact's last name.

accountstring or nullOptionalformat: "uuid"

The contact's account.

ownerstring or nullOptionalformat: "uuid"

The contact's owner.

addresseslist of objectsOptional

email_addresseslist of objectsOptional

phone_numberslist of objectsOptional

last_activity_atdatetime or nullOptional

When the contact's last activity occurred.

remote_created_atdatetime or nullOptional

When the third party's contact was created.

remote_datalist of objects or nullOptionalRead-only

remote_fieldslist of objectsOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional

The contact's first name.

last_namestring or nullOptional

The contact's last name.

accountstring or nullOptionalformat: "uuid"

The contact's account.

addresseslist of objectsOptional

email_addresseslist of objectsOptional

phone_numberslist of objectsOptional

remote_created_atdatetime or nullOptional

When the third party's contact was created.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional

The contact's first name.

last_namestring or nullOptional

The contact's last name.

accountstring or nullOptionalformat: "uuid"

The contact's account.

ownerstring or nullOptionalformat: "uuid"

The contact's owner.

addresseslist of objectsOptional

email_addresseslist of objectsOptional

phone_numberslist of objectsOptional

last_activity_atdatetime or nullOptional

When the contact's last activity occurred.

remote_created_atdatetime or nullOptional

When the third party's contact was created.

remote_datalist of objects or nullOptionalRead-only

remote_fieldslist of objectsOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional

The contact's first name.

last_namestring or nullOptional

The contact's last name.

accountstring or nullOptionalformat: "uuid"

The contact's account.

addresseslist of objectsOptional

email_addresseslist of objectsOptional

phone_numberslist of objectsOptional

remote_created_atdatetime or nullOptional

When the third party's contact was created.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional

The contact's first name.

last_namestring or nullOptional

The contact's last name.

accountstring or nullOptionalformat: "uuid"

The contact's account.

addresseslist of objectsOptional

email_addresseslist of objectsOptional

phone_numberslist of objectsOptional

remote_created_atdatetime or nullOptional

When the third party's contact was created.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional

The contact's first name.

last_namestring or nullOptional

The contact's last name.

accountstring or nullOptionalformat: "uuid"

The contact's account.

email_addresseslist of objectsOptional

phone_numberslist of objectsOptional

last_activity_atdatetime or nullOptional

When the contact's last activity occurred.

remote_created_atdatetime or nullOptional

When the third party's contact was created.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional

The contact's first name.

last_namestring or nullOptional

The contact's last name.

accountstring or nullOptionalformat: "uuid"

The contact's account.

addresseslist of objectsOptional

email_addresseslist of objectsOptional

phone_numberslist of objectsOptional

remote_created_atdatetime or nullOptional

When the third party's contact was created.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional

The contact's first name.

last_namestring or nullOptional

The contact's last name.

accountstring or nullOptionalformat: "uuid"

The contact's account.

ownerstring or nullOptionalformat: "uuid"

The contact's owner.

addresseslist of objectsOptional

email_addresseslist of objectsOptional

phone_numberslist of objectsOptional

last_activity_atdatetime or nullOptional

When the contact's last activity occurred.

remote_created_atdatetime or nullOptional

When the third party's contact was created.

remote_datalist of objects or nullOptionalRead-only

remote_fieldslist of objectsOptionalRead-only

Authentication

Headers

Query parameters

Response

Field support by integration

Field support by integration