/contacts

import { MergeClient } from "@mergeapi/merge-node-client";
const client = new MergeClient({ apiKey: "YOUR_API_KEY", accountToken: "YOUR_ACCOUNT_TOKEN" });
const pageableResponse = await client.accounting.contacts.list({
    companyId: "company_id",
    createdAfter: new Date("2024-01-15T09:30:00.000Z"),
    createdBefore: new Date("2024-01-15T09:30:00.000Z"),
    cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
    emailAddress: "email_address",
    includeDeletedData: true,
    includeRemoteData: true,
    includeRemoteFields: true,
    includeShellData: true,
    isCustomer: "is_customer",
    isSupplier: "is_supplier",
    modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
    modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
    name: "name",
    pageSize: 1,
    remoteFields: "status",
    remoteId: "remote_id",
    showEnumOrigins: "status",
    status: ""
});
for await (const item of pageableResponse) {
    console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.accounting.contacts.list({
    companyId: "company_id",
    createdAfter: new Date("2024-01-15T09:30:00.000Z"),
    createdBefore: new Date("2024-01-15T09:30:00.000Z"),
    cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
    emailAddress: "email_address",
    includeDeletedData: true,
    includeRemoteData: true,
    includeRemoteFields: true,
    includeShellData: true,
    isCustomer: "is_customer",
    isSupplier: "is_supplier",
    modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
    modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
    name: "name",
    pageSize: 1,
    remoteFields: "status",
    remoteId: "remote_id",
    showEnumOrigins: "status",
    status: ""
});
while (page.hasNextPage()) {
    page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;

1	{
2	"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
3	"previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
4	"results": [
5	{
6	"id": "c640b80b-fac9-409f-aa19-1f9221aec445",
7	"remote_id": "11167",
8	"created_at": "2021-09-15T00:00:00Z",
9	"modified_at": "2021-10-16T00:00:00Z",
10	"name": "Gil Feig's pickleball store",
11	"is_supplier": true,
12	"is_customer": true,
13	"email_address": "[email protected]",
14	"tax_number": "12-3456789",
15	"status": "ACTIVE",
16	"currency": "USD",
17	"remote_updated_at": "2020-03-31T00:00:00Z",
18	"company": "595c8f97-2ac4-45b7-b000-41bdf43240b5",
19	"addresses": [
20	{},
21	{}
22	],
23	"phone_numbers": [
24	{
25	"number": "+3198675309",
26	"type": "Mobile"
27	}
28	],
29	"remote_was_deleted": true,
30	"field_mappings": {
31	"organization_defined_targets": {
32	"custom_key": "custom_value"
33	},
34	"linked_account_defined_targets": {
35	"custom_key": "custom_value"
36	}
37	},
38	"remote_data": [
39	{
40	"path": "/actions"
41	}
42	],
43	"remote_fields": [
44	{
45	"remote_field_class": {
46	"id": "string",
47	"display_name": "string",
48	"remote_key_name": "string",
49	"description": "string",
50	"is_custom": true,
51	"is_common_model_field": true,
52	"is_required": true,
53	"field_type": "string",
54	"field_format": "string",
55	"field_choices": [
56	"string"
57	],
58	"item_schema": {
59	"item_type": "string",
60	"item_format": "string",
61	"item_choices": [
62	"string"
63	]
64	}
65	},
66	"value": "string"
67	}
68	]
69	}
70	]
71	}

Returns a list of Contact objects.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Query parameters

company_idstringOptional

If provided, will only return contacts for this company.

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_addressstringOptional

If provided, will only return Contacts that match this email.

expandenumOptional

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

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).

is_customerstringOptional

If provided, will only return Contacts that are denoted as customers.

is_supplierstringOptional

If provided, will only return Contacts that are denoted as suppliers.

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.

namestringOptional

If provided, will only return Contacts that match this name.

page_sizeintegerOptional

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

remote_fieldsenumOptional

Deprecated. Use show_enum_origins.

Allowed values:

remote_idstringOptional

The API provider's ID for the given object.

show_enum_originsenumOptional

A comma separated list of enum field names for which you’d like the original values to be returned, instead of Merge’s normalized enum values. Learn more

A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)

Allowed values:

statusenumOptional

If provided, will only return Contacts that match this status.

Allowed values:

Response

nextstring or null

previousstring or null

resultslist of objects

Authentication

Headers

Query parameters

Response

Field support by integration