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

# Teamwork plugin

> Teamwork.com projects, tasks, task lists, milestones, comments, time tracking, timers, people and companies.

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

Store each tenant's Teamwork site as site\_name with its API key: acme for acme.teamwork.com, acme.eu for an EU site. The optional siteName plugin option is a global single-site override.

**What you get:**

* 220 typed API operations

## Setup

**1. Install**

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

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

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

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

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

## Example API calls

**List a project's open tasks**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.teamwork.api.tasks.list({
	query: {
		projectIds: [1470497],
		includeCompletedTasks: false,
	},
});
```

**Create a task without emailing anyone**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.teamwork.api.tasks.create({
	path: { tasklistId: 4073104 },
	body: {
		task: { name: 'Draft the launch post' },
		taskOptions: { notify: false },
	},
});
```

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

## What's next

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