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

# Pipeline CRM plugin

> Pipeline CRM is a sales CRM for deals, people and companies. This plugin manages deals with stages and values, people and companies with their associations, records activities (notes) on any record, and reads the visible users.

Use **Pipeline CRM** through Corsair: one client, typed API calls.

Authenticate with an API token from the Pipeline CRM profile (tokens begin pcrm\_live\_ in production); the plugin sends it as an Authorization Bearer token. Every call goes against [https://api.pipelinecrm.com/api/v3](https://api.pipelinecrm.com/api/v3). Lists answer \{ entries, pagination } with page and per\_page (at most 200) paging; every write wraps its fields in the record name (\{ deal: \{...} }, \{ person: \{...} }).
Filtering uses bracketed conditions parameters: pass conditions as a map of full bracketed keys to values, e.g. "conditions\[deal\_stage]\[]": 3 or "conditions\[deal\_created]\[selection]": "last\_30" — each list page documents its keys, and the API ignores unknown keys rather than rejecting them. Sorting uses sort=\<field> or sort=-\<field> with record field names such as value or created\_at (sort=-deal\_value answers 500). Money fields such as a deal's value serialize as decimal strings ("12000.0"); send numbers or numeric strings.
Tokens are rate limited to 10 requests per second per user; exceeding answers 429 \{"error":"Rate limit exceeded"} and the plugin retries with backoff. Deleting a deal, person, company or activity cannot be undone.
The API documents far more than this plugin covers (CSV exports, calendar entries, call and SMS logs, comments, files, projects, saved searches, admin custom fields, pipelines, JWT auth for interactive clients, …), all on the same shapes. Every operation is described in the official reference: [https://app.pipelinecrm.com/api/docs](https://app.pipelinecrm.com/api/docs)

**What you get:**

* 29 typed API operations

## Setup

**1. Install**

```bash npm theme={null}
npm install corsair @corsair-dev/pipelinecrm better-sqlite3
npm install --save-dev @types/better-sqlite3
```

```bash yarn theme={null}
yarn add corsair @corsair-dev/pipelinecrm better-sqlite3
yarn add --dev @types/better-sqlite3
```

```bash pnpm theme={null}
pnpm install corsair @corsair-dev/pipelinecrm better-sqlite3
pnpm install --save-dev @types/better-sqlite3
```

```bash bun theme={null}
bun add corsair @corsair-dev/pipelinecrm better-sqlite3
bun add --dev @types/better-sqlite3
```

**2. Add the plugin**

```ts corsair.ts theme={null}
import Database from 'better-sqlite3';
import { createCorsair } from 'corsair';
import { pipelinecrm } from '@corsair-dev/pipelinecrm';

export const corsair = createCorsair({
	plugins: [
		pipelinecrm(),
	],
	database: new Database('corsair.db'),
	kek: process.env.CORSAIR_KEK!,
	multiTenancy: true,
	hub: {
		projectApiKey: process.env.CORSAIR_API_KEY!,
		signingSecret: process.env.CORSAIR_SIGNING_SECRET!,
	},
});
```

With `multiTenancy: true`, scope calls with `corsair.withTenant(id)`. See [Quick start](https://docs.corsair.dev/quick-start.md) for KEK + Hub keys, and [Multi-tenancy](https://docs.corsair.dev/concepts/multi-tenancy.md) for account isolation.

**3. Choose authentication**

> [tab] API Key (Recommended)
>
> Store the Pipeline CRM API key before the first call: `pnpm corsair setup --plugin=pipelinecrm --tenant=acme api_key=<your-key>` (leave out `--tenant` without `multiTenancy`), or pass it as `key` in the plugin options. With Hub, each tenant enters their own key on the connect page. See [API key auth](https://docs.corsair.dev/concepts/api-key).
>
> ```ts theme={null}
> pipelinecrm()
> ```
>
> More: [API Key](https://docs.corsair.dev/concepts/api-key)

**4. Connect a tenant**

Mint a connect link and send the tenant to it. Hub hosts the page and delivers the result to your app — see [Connect / OAuth](https://docs.corsair.dev/management/connect).

```ts theme={null}
const { connectUrl } = await corsair.manage.connect.createLink({
	plugin: 'pipelinecrm',
	tenantId: 'acme',
});
// redirect the user's browser to connectUrl
```

## Example API calls

**Read a deal**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.pipelinecrm.api.deals.get({ id: 4521 });
```

**Create a deal**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.pipelinecrm.api.deals.create({ name: 'Acme renewal', value: 12000 });
```

See the full list on the [API](https://docs.corsair.dev/plugins/pipelinecrm/api.md) page.

## What's next

> [card] [API reference](https://docs.corsair.dev/plugins/pipelinecrm/api.md)
>
> Every `pipelinecrm.api.*` operation with input and output types.

> [card] [Connect / OAuth](https://docs.corsair.dev/management/connect)
>
> createLink, Hub delivery, and tenant connect flows.

> [card] [Use with agents](https://docs.corsair.dev/mcp-adapters/mcp-adapters)
>
> Expose this plugin's operations as MCP tools.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.