> ## Documentation Index
> Fetch the complete documentation index at: https://docs.withampersand.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Salesflare

## What's supported

### Supported actions

This connector supports:

* [Write Actions](/write-actions).
* [Read Actions](/read-actions), including full historic backfill and incremental read.
* [Proxy Actions](/proxy-actions), using the base URL `https://api.salesflare.com`.

### Supported Objects

The Salesflare connector supports reading from and writing to the following objects:

* [accounts](https://api.salesflare.com/docs#operation/getAccounts)
* [contacts](https://api.salesflare.com/docs#operation/getContacts)
* [currencies](https://api.salesflare.com/docs#operation/getCurrencies) (read only)
* [email](https://api.salesflare.com/docs#operation/getDatasourcesEmail)
* [groups](https://api.salesflare.com/docs#operation/getGroups) (read only)
* [me/contacts](https://api.salesflare.com/docs#operation/getMeContacts) (read only)
* [opportunities](https://api.salesflare.com/docs#operation/getOpportunities)
* [persons](https://api.salesflare.com/docs#operation/getPersons) (read only)
* [pipelines](https://api.salesflare.com/docs#operation/getPipelines) (read only)
* [stages](https://api.salesflare.com/docs#operation/getStages) (read only)
* [tags](https://api.salesflare.com/docs#operation/getTags)
* [tasks](https://api.salesflare.com/docs#operation/getTasks)
* [users](https://api.salesflare.com/docs#operation/getUsers) (read only)
* [workflows](https://api.salesflare.com/docs#operation/getWorkflows)

### Example integration

To define an integration for Salesflare, create a manifest file that looks like this:

```YAML theme={null}
# amp.yaml
specVersion: 1.0.0
integrations:
  - name: salesflare-integration
    displayName: My Salesflare Integration
    provider: salesflare
    proxy:
      enabled: true
```

## Before You Get Started

To use the Salesflare connector, you'll need an API key from your Salesflare account. Here's how to get it:

1. Log in to your [Salesflare account](https://app.salesflare.com/).
2. Go to Settings > API Keys.
3. Generate a new API key.

For more information about authentication, see the [Salesflare API documentation](https://api.salesflare.com/docs#section/Introduction/Authentication).

## Using the connector

This connector uses API Key auth, which means that you do not need to set up a Provider App before getting started. (Provider apps are only required for providers that use OAuth2 Authorization Code grant type.)

To start integrating with Salesflare:

* Create a manifest file like the example above.
* Deploy it using the [amp CLI](/cli/overview).
* Embed the [InstallIntegration](/embeddable-ui-components#install-integration) UI component. The UI component will prompt the customer for an API key.
* Start making [Proxy Calls](/proxy-actions), and Ampersand will automatically attach the API key supplied by the customer. Please note that this connector's base URL is `https://api.salesflare.com`.

For detailed information about available endpoints and request formats, refer to the [Salesflare API Reference](https://api.salesflare.com/docs).