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

# Folk plugin

> Manage people, companies, groups, interactions, notes, users, and credits with Folk's relationship management API.

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

Folk provides a public REST API at `https://api.folk.app/v1` to manage relationships for service businesses and high-touch teams.

* **Authentication:** Use an API key from workspace settings under API. Pass it as a Bearer token (`Authorization: Bearer <key>`).
* **Rate limits:** Folk applies rate limits per user across two concurrent windows: a default limit of 600 requests per minute, and a burst limit of 20 requests per 2 seconds. The plugin automatically reads standard `Retry-After` headers on 429 responses.
* **Idempotency:** Modifying endpoints (`POST`, `PATCH`, `DELETE`) accept an optional `idempotencyKey` parameter that passes an `Idempotency-Key` header to safely retry requests without duplication.
* **Custom fields:** People and companies support `customFieldValues` mapped by group ID and custom field name.

**What you get:**

* 33 typed API operations

## Setup

**1. Install**

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

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

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

```bash bun theme={null}
bun add corsair @corsair-dev/folk 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 { folk } from '@corsair-dev/folk';

export const corsair = createCorsair({
	plugins: [
		folk(),
	],
	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 Folk API key before the first call: `pnpm corsair setup --plugin=folk --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}
> folk()
> ```
>
> 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: 'folk',
	tenantId: 'acme',
});
// redirect the user's browser to connectUrl
```

## Example API calls

**List workspace contacts**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.folk.api.people.list({ limit: 10 });
```

**Create a person contact**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.folk.api.people.create({
	firstName: 'Jane',
	lastName: 'Doe',
	emails: ['jane.doe@example.com'],
});
```

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

## What's next

> [card] [API reference](https://docs.corsair.dev/plugins/folk/api.md)
>
> Every `folk.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.