# CRM connector requirements

To activate BrightSync (prebuilt CRM sync logic) for your CRM platform we need to add a new platform connector that will use your REST API. The CRM connector requires a number of API methods that we ask you to describe:

### **Authentication**

***

The connector needs to connect to your API on behalf of your user. How does your API authenticate?

* Using OAuth2 Bearer token
* Using Basic auth with an API token
* Using another auth method

### **CRM Users**

***

A User object represents a user in your CRM system (OrgId, UserId, Name, Email, Timezone). The connector needs to be able to receive information about the current user and optionally be able to find other user records:

* **getMe** - current user information (OrgId, UserId, Name, Email, Timezone)
* **getUsersByEmail** (email or list of emails) - good to have

### **Sync Specific API Requirements**

* [Email Sync](https://docs.aurinko.io/brightsync/crm-connector-requirements/email-sync-api-requirements)
* [Calendar Sync](https://docs.aurinko.io/brightsync/crm-connector-requirements/calendar-sync-api-requirements)