/contacts/{id}

import { MergeClient } from "@mergeapi/merge-node-client";
const client = new MergeClient({ apiKey: "YOUR_API_KEY", accountToken: "YOUR_ACCOUNT_TOKEN" });
await client.crm.contacts.retrieve("id", {
    includeRemoteData: true,
    includeRemoteFields: true,
    includeShellData: true
});

1	{
2	"id": "550e8400-e29b-41d4-a716-446655440000",
3	"remote_id": "19202938",
4	"created_at": "2021-09-15T00:00:00Z",
5	"modified_at": "2021-10-16T00:00:00Z",
6	"first_name": "Gil",
7	"last_name": "Feig",
8	"account": "0958cbc6-6040-430a-848e-aafacbadf4ae",
9	"owner": "b8fbfc30-0982-420e-8c20-dab07b70b9d6",
10	"addresses": [
11	{
12	"created_at": "2021-09-15T00:00:00Z",
13	"modified_at": "2021-10-16T00:00:00Z",
14	"street_1": "50 Bowling Green Dr",
15	"street_2": "Golden Gate Park",
16	"city": "San Francisco",
17	"state": "CA",
18	"postal_code": "94122",
19	"country": "US",
20	"address_type": "BILLING"
21	}
22	],
23	"email_addresses": [
24	{
25	"email_address": "[email protected]",
26	"email_address_type": "Work"
27	}
28	],
29	"phone_numbers": [
30	{
31	"created_at": "2021-09-15T00:00:00Z",
32	"modified_at": "2021-10-16T00:00:00Z",
33	"phone_number": "+13785579223",
34	"phone_number_type": "Mobile"
35	}
36	],
37	"last_activity_at": "2022-02-10T00:00:00Z",
38	"remote_created_at": "2021-11-10T00:00:00Z",
39	"remote_was_deleted": true,
40	"field_mappings": {
41	"organization_defined_targets": {
42	"custom_key": "custom_value"
43	},
44	"linked_account_defined_targets": {
45	"custom_key": "custom_value"
46	}
47	},
48	"remote_data": [
49	{
50	"path": "/contacts"
51	}
52	],
53	"remote_fields": [
54	{
55	"remote_field_class": {
56	"id": "string",
57	"display_name": "string",
58	"remote_key_name": "string",
59	"description": "string",
60	"is_custom": true,
61	"is_common_model_field": true,
62	"is_required": true,
63	"field_type": "string",
64	"field_format": "string",
65	"field_choices": [
66	"string"
67	],
68	"item_schema": {
69	"item_type": "string",
70	"item_format": "string",
71	"item_choices": [
72	"string"
73	]
74	}
75	},
76	"value": "string"
77	}
78	]
79	}

Returns a Contact object with the given id.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Path parameters

idstringRequiredformat: "uuid"

Query parameters

expandenumOptional

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

Allowed values:

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

Response

idstringRead-onlyformat: "uuid"

remote_idstring or null

The third-party API ID of the matching object.

created_atdatetimeRead-only

The datetime that this object was created by Merge.

modified_atdatetimeRead-only

The datetime that this object was modified by Merge.

first_namestring or null

The contact's first name.

last_namestring or null

The contact's last name.

accountstring or nullformat: "uuid"

The contact's account.

ownerstring or nullformat: "uuid"

The contact's owner.

addresseslist of objects

email_addresseslist of objects

phone_numberslist of objects

last_activity_atdatetime or null

When the contact's last activity occurred.

remote_created_atdatetime or null

When the third party's contact was created.

remote_was_deletedbooleanRead-only

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.

field_mappingsobject or nullRead-only

remote_datalist of objects or nullRead-only

remote_fieldslist of objectsRead-only

/contacts/{id}

Authentication

Path parameters

Headers

Query parameters

Response

Field support by integration