> ## 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.

# Capsule

## 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.capsulecrm.com/api`.

### Supported Objects

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

* [activitytypes](https://developer.capsulecrm.com/v2/models/activity_type)
* [boards](https://developer.capsulecrm.com/v2/models/board)
* [categories](https://developer.capsulecrm.com/v2/models/category)
* [countries](https://developer.capsulecrm.com/v2/models/country)
* [lostreasons](https://developer.capsulecrm.com/v2/models/lost_reason)
* [milestones](https://developer.capsulecrm.com/v2/models/milestone)
* [opportunities](https://developer.capsulecrm.com/v2/models/opportunity)
* [projects](https://developer.capsulecrm.com/v2/models/project)
* [parties](https://developer.capsulecrm.com/v2/models/party)
* [pipelines](https://developer.capsulecrm.com/v2/models/pipeline)
* [stages](https://developer.capsulecrm.com/v2/models/stage)
* [tasks](https://developer.capsulecrm.com/v2/models/task)
* [teams](https://developer.capsulecrm.com/v2/models/team)
* [titles](https://developer.capsulecrm.com/v2/models/title)
* [trackdefinitions](https://developer.capsulecrm.com/v2/models/track_definition)
* [users](https://developer.capsulecrm.com/v2/models/user)

## Before You Get Started

To integrate Capsule CRM with Ampersand, you will need [a Capsule CRM Developer Account](https://developer.capsulecrm.com/).

Once your account is created, you'll need to create an app in Capsule CRM, configure the Ampersand redirect URI within the app, and obtain the following credentials from your app:

* Client ID
* Client Secret
* Scopes

You will then use these credentials and scopes to connect your application to Ampersand.

### Create a Capsule CRM Account

Here's how you can sign up for a Capsule CRM account:

* Go to the [Capsule CRM Developer portal](https://developer.capsulecrm.com/) and sign up using your *Github* account.

### Creating a Capsule CRM App

Follow the steps below to create a Capsule CRM app:

1. Log in to your [Capsule CRM Developer account](https://capsulecrm.com/developers).

2. Click **Your Applications**.

3. Click **New Application**.

4. Enter the following details in the *Create a new application* form:

   1. **Name**: Enter the name of your Capsule CRM account or organization.
   2. **Description**: Provide a brief overview of your application's functionality and purpose.
   3. **URL**: Specify the URL of your application's landing page.
   4. **Redirect URIs**: Use `https://api.withampersand.com/callbacks/v1/oauth` as the Redirect URI.
   5. **Contact Email**: Provide the email address linked to your Capsule CRM account. This will be used for any communication regarding your app.
   6. **Application Type**: Choose the type of application you are developing.

5. Click **Save**. You will see the **Client ID** and **Client Secret** in the app details. Note these credentials, as you will need them to connect your app to Ampersand.

<img src="https://mintcdn.com/ampersand-24eb5c1a/Bx3tggG51e0liOp-/images/provider-guides/596ef48-capsulecrm1.gif?s=b15aef7d7c46f3bdc555f0de59e5bfd2" alt="Capsule CRM App Creation" width="1680" height="822" data-path="images/provider-guides/596ef48-capsulecrm1.gif" />

<br />

## Add Your Capsule CRM App Info to Ampersand

1. Log in to your [Ampersand Dashboard](https://dashboard.withampersand.com).

2. Select the project where you want to create a Capsule CRM integration.

   <img src="https://mintcdn.com/ampersand-24eb5c1a/CkzFg-K1u4gYx3ZD/images/provider-guides/dd47b7a-Ampersand.png?fit=max&auto=format&n=CkzFg-K1u4gYx3ZD&q=85&s=d580aa00cc421fe14cfbab79c2e0812f" alt="Ampersand Project Selection" width="2244" height="442" data-path="images/provider-guides/dd47b7a-Ampersand.png" />

3. Select **Provider Apps**.

4. Select *Capsule CRM* from the **Provider** list.

5. Enter the previously obtained **Client ID** in the **Client ID** field and the **Client Secret** in the **Client Secret** field.

6. Enter the scopes set for your application in *Capsule CRM*.

<img src="https://mintcdn.com/ampersand-24eb5c1a/Bx3tggG51e0liOp-/images/provider-guides/30e4ef5-capsulcrm2.gif?s=5c8cd036ed2dd1c5eee9a64ffae639d9" alt="Ampersand Integration" width="766" height="476" data-path="images/provider-guides/30e4ef5-capsulcrm2.gif" />

7. Click **Save Changes**.
