getContact( )

Retrieves a contact.

Getting Merged Contacts

When a source contact is merged with a target contact, the source contact is deleted. When calling Get Contact for a merged contact, you can use the source or target contact ID. In both bases, the target contact is returned.

This is supported only when calling Get Contact on merged contacts. Previously deleted source contact IDs can't be used for any other method.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Set Up Automations
Manage Members and Contacts - all permissions
Read Members and Contacts - all read permissions
Manage Contacts
Read Contacts
Manage Events
Manage Restaurants - all permissions
Learn more about app permissions.
Method Declaration
Copy
function getContact(_id: string, options: GetContactOptions): Promise<Contact>;
Method Parameters
_idstringRequired

ID of the contact to retrieve.

optionsGetContactOptions

Get contact options.

Returns
Return Type:Promise<Contact>
JavaScript
import { contacts } from "@wix/crm";

/* Sample contactId value: '2712ae1d-3f64-46c2-ac3a-94a6c2e29847' */

export async function myGetContactFunction(id) {
  try {
    const contact = await contacts.getContact(id);
    const contactId = contact._id;
    const contactName = contact.info.name.first;

    return contact;
  } catch (error) {
    console.log(error);
    // Handle the error
  }
}

/* Promise resolves to:
 * {
 *   "revision": 1,
 *   "source": {
 *     "sourceType": "WIX_CODE",
 *     "appId": "151e476a-715e-ec33-db9a-a7ff4d51f70a"
 *   },
 *   "lastActivity": {
 *     "activityDate": "2023-12-24T11:50:46.048Z",
 *     "activityType": "CONTACT_CREATED"
 *   },
 *   "primaryInfo": {
 *     "email": "johndoe1@example.com",
 *     "phone": "6465676359"
 *   },
 *   "info": {
 *     "name": {
 *       "first": "John",
 *       "last": "Doe"
 *     },
 *     "emails": {
 *       "items": [
 *         {
 *           "tag": "UNTAGGED",
 *           "email": "johndoe1@example.com",
 *           "primary": true,
 *           "_id": "37db3bde-83c0-4ca2-8097-88964a2f343b"
 *         },
 *       ]
 *     },
 *     "phones": {
 *       "items": [
 *         {
 *           "tag": "MOBILE",
 *           "countryCode": "US",
 *           "phone": "646-567-6359",
 *           "e164Phone": "+16465676359",
 *           "primary": true,
 *           "_id": "ed1d7da0-b4a1-4164-81b7-c49dedc25dd7"
 *         }
 *       ]
 *     },
 *     "addresses": {
 *       "items": [
 *         {
 *           "tag": "HOME",
 *           "address": {
 *             "formatted": "3 Park Ave\nNY, New York 10010\nUnited States",
 *             "addressLine1": "3 Park Ave",
 *             "city": "NY",
 *             "subdivision": "US-NY",
 *             "country": "US",
 *             "postalCode": "10010"
 *           },
 *           "_id": "eeb4e174-fd0f-4ce8-8cac-dc152f284228"
 *         }
 *       ]
 *     },
 *     "company": "Wix",
 *     "jobTitle": "Writer",
 *     "birthdate": "1995-04-25",
 *     "locale": "en-us",
 *     "labelKeys": {
 *       "items": [
 *         "custom.contact"
 *       ]
 *     },
 *     "extendedFields": {
 *       "items": {
 *         "contacts.displayByLastName": "Doe John",
 *         "invoices.vatId": "",
 *         "emailSubscriptions.deliverabilityStatus": "NOT_SET",
 *         "emailSubscriptions.subscriptionStatus": "UNSUBSCRIBED",
 *         "contacts.displayByFirstName": "John Doe",
 *         "custom.nickname": "Jonny"
 *       }
 *     }
 *   },
 *   "_id": "2712ae1d-3f64-46c2-ac3a-94a6c2e29847",
 *   "_createdDate": "2023-12-24T11:50:46.049Z",
 *   "_updatedDate": "2023-12-24T12:50:46.047Z"
 * }
 */
Errors
404Not Found

There is 1 error with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?