# About the Contacts API

The Contacts API allows you to create and manage contacts. When a new visitor first shares their contact information with a site, they're added to the site's [contact list](fallback::https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Fcontacts). You can then access contacts and their details using the Contacts API. 


A site visitor becomes a contact when:
- The site visitor:
  - Submits their contact details to a form, such as event registrations, customer support inquiries, or billing address submissions.
  - Registers as a member of the site. 
- A Wix user:
 - [Imports a contact](fallback::https://support.wix.com/en/article/importing-contacts-by-uploading-a-csv-file-1066522). 
 - [Adds a contact manually](fallback::https://support.wix.com/en/article/manually-adding-contacts).
- You: 
  - [Create a contact](fallback::https://dev.wix.com/docs/sdk/backend-modules/crm/contacts/create-contact) with the Contacts API.

Learn more about how Wix users can [manage a site's contact list](fallback::https://support.wix.com/en/article/about-your-contact-list). 


With the Contacts API, you can:
- Create, manage, and categorize contacts. 
- Retrieve information about existing contacts. 


## Before you begin

It's important to note the following points before starting to code:
- You can't label or unlabel a contact if the label doesn't exist. To retrieve or create a label, use the [Labels API](fallback::https://dev.wix.com/docs/sdk/backend-modules/crm/labels/introduction).
- Merging a contact is irreversible. 
- Wix users can only be specified as the target contact when merging contacts.


## Terminology

- **Label:** A tag that enables Wix users to organize and group contacts. 
- **Extended field:** An additional property that stores contact information.
- **Source contact:** A contact you intend to merge into a target contact. These contacts get deleted after being merged. 
- **Target contact:** A contact that receives merged data from source contacts.

@package_metadata:@wix/crm

To use the Contacts API, install the `@wix/crm` package.

#### Install the package

Follow the installation instructions for your development environment.

| Development environment | Installation method |
|--|--|
| Wix sites (editor or IDE) | Use the [package manager](fallback::https://dev.wix.com/docs/develop-websites/articles/coding-with-velo/packages/work-with-npm-packages-in-the-editor). |
| Wix sites (local IDE) | Run `wix install @wix/crm` using the [Wix CLI](fallback::https://dev.wix.com/docs/develop-websites/articles/coding-with-velo/packages/work-with-npm-packages-with-the-wix-cli).|
| Blocks apps | Use the same installation method as Wix sites. |
| CLI and self-hosted apps | Run `npm install @wix/crm` or `yarn add @wix/crm`. |
| Headless sites and apps | Run `npm install @wix/crm` or `yarn add @wix/crm`. |

#### Import the package

To import the package in your code:

```js
import { contacts } from '@wix/crm'
```

Coding Examples

Sled Tests

Go Headless

Build Apps

Client

API Preview

Ricos

Develop Websites

REST

Velo

Picasso

GraphQL (Alpha)

onContactMerged( )