# About the Notes API

The Notes API allows you to create and manage notes associated with a specific contact on a site. Notes allow Wix users to document interactions, meetings, phone calls, and other important details about their contacts. This helps Wix users become more organized and provide relevant context for future interactions with their contacts. 

With the Notes API, you can:
- Create, update, and delete notes associated with a contact. 
- Retrieve and query notes. 

## Before you begin

It's important to note the following points before starting to code: 

- All notes must be associated with a contact. When creating a note, you need to specify an existing contact ID. 
- The maximum size of a note's text is 2048 characters. 


## Terminology
- **Note**: A text-based record associated with a contact that documents interactions, meetings, calls, or other important information.
- **Note type**: Optional classification for organizing notes by their purpose: 
    - `NOT_SET`: General notes about a contact.
    - `MEETING_SUMMARY`: Summary notes following a meeting with a contact. 
    - `CALL_SUMMARY`: Summary notes following a call with a contact.

@package_metadata:@wix/crm

To use the Notes 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 { notes } from '@wix/crm'
```

Coding Examples

Sled Tests

Go Headless

Build Apps

Client

API Preview

Ricos

Develop Websites

REST

Velo

Picasso

GraphQL (Alpha)

PROPERTY	SUPPORTED FILTERS & SORTING
`_id`	`eq()`,`in()`
`_createdDate`	`eq()`,`ne()`,`exists()`,`in()`,`hasSome()`,`lt()`,`le()`,`gt()`,`ge()`,`ascending()`,`descending()`
`_updatedDate`	`eq()`,`ne()`,`exists()`,`in()`,`hasSome()`,`lt()`,`le()`,`gt()`,`ge()`,`ascending()`,`descending()`
`contactId`	`eq()`,`in()`
`type`	`eq()`,`in()`,`ne()`

queryNotes( )