# 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](/brightsync/crm-connector-requirements/email-sync-api-requirements.md)
* [Calendar Sync](/brightsync/crm-connector-requirements/calendar-sync-api-requirements.md)


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.aurinko.io/brightsync/crm-connector-requirements.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.