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

# Fireberry plugin

> Operate Fireberry CRM records, metadata, custom fields and objects, attachments, queries, and batch actions through typed Corsair endpoints.

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

Configure an API key in Corsair. Fireberry REST and Batch endpoints send it as the tokenid header; Metadata API calls follow the documented tokenid query parameter. API route inventory: 244 documented method/path operations across REST, Metadata, and Batch; 243 are dispatched by the generic typed Corsair operations. The Date & Time custom field update route is excluded because its published path and parameter contradict one another. No inbound webhook contract is published in the API index, so webhooks are not exposed.

**What you get:**

* 24 typed API operations

## Setup

**1. Install**

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

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

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

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

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

## Example API calls

**Inspect an account field**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.fireberry.api.metadata.field({ id: 1, fieldName: 'accountname' });
```

**Create an account with the Batch API**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.fireberry.api.batch.create({
	objectCode: 'account',
	data: [{ accountname: 'Example Company' }],
});
```

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

## What's next

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