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

# Rocketlane plugin

> Professional services automation with Rocketlane - read and write tasks, projects, customer companies, time entries and team members, and archive a project.

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

Generate a key in Rocketlane under **Settings → API**, then send it in the `api-key` header. The base URL is `https://api.rocketlane.com/api` and every route carries its own version segment (`/1.0/...`). Things to know before you call:

* **Paging is a token, not a page number.** Each list returns its records under a named array (`tasks`, `projects`, ...) with `next_page_token`, `has_more` and the provider's `pagination` block; pass `next_page_token` back as `page_token`. **The token expires after 15 minutes**, so a paginated walk has to keep moving rather than pausing between pages.
* **Filters are `field.operator` query keys.** Rocketlane reads a filter as a key such as `projectName.cn`, with a documented operator set: `eq`, `cn`, `nc`, `oneOf`, `noneOf`, and the numeric `gt`/`ge`/`lt`/`le`. Each filter accepts only the operators the reference lists for it, so a typo fails before the request instead of being dropped. `match` sets how filters combine (`all` or `any`), and `sort_order` is `ASC` or `DESC`.
* **Statuses are numbers with labels.** A project or task `status` comes back as `{ value, label }`; filter and set it by `value`. The OpenAPI document types the filter as a string while its example is the bare number `1`, so `tasks.list` accepts either for `task_status` and `project_status`.
* **Team members get an email.** Rocketlane emails an invite to every user added through `team_member_ids` on `projects.create`.
* **Create needs a customer and an owner.** `projects.create` takes a `customer` block naming either a company id or a company name, and an `owner` block naming either a user id or an email. A block that names neither is rejected before the request is sent.
* **Ids live in the path, never the body.** `tasks.update`, `projects.update` and `companies.update` send the id in the URL and the changed fields in the body. The update calls take fewer fields than create: a task's project, phase, assignees and followers, and a project's customer and members, are not part of an update and are rejected.
* **Deletes answer 204.** `tasks.delete`, `projects.delete`, `companies.delete` and `timeEntries.delete` return no body, so the plugin reports `{ success: true, id }` from the id you sent. **These are permanent**, which is why they are marked destructive.
* **Archiving is not deleting.** `projects.archive` posts to the project's `/archive` action and keeps the records, so it is a write rather than a destructive call.
* **An unknown id answers 403, not 404.** A get or delete on an id that does not exist on the instance comes back as `403 Forbidden`, so it is not retried.
* **Lists trail writes by a few seconds.** A list right after a create can miss the new record, so poll rather than read once.
* **Time entries are capped per day.** Rocketlane rejects entries that would push a single day past 1440 minutes; the plugin requires at least one minute per entry but cannot see the other entries already logged for that day.
* **Retries.** Rocketlane documents no throughput window and no `Retry-After`, so a 429 is retried three times with exponential backoff. A 5xx is retried only for a call the plugin declared read-only, never for a create.

**What you get:**

* 22 typed API operations

## Setup

**1. Install**

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

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

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

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

export const corsair = createCorsair({
	plugins: [
		rocketlane(),
	],
	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)
>
> No setup required yet. When you make your first request as a tenant, Corsair prompts for the API key.
>
> ```ts theme={null}
> rocketlane()
> ```
>
> 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: 'rocketlane',
	tenantId: 'acme',
});
// redirect the user's browser to connectUrl
```

## Example API calls

**List tasks in a project**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.rocketlane.api.tasks.list({
	project_id: { eq: 201 },
	page_size: 50,
});
```

**Create a task in a project**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.rocketlane.api.tasks.create({
	task_name: 'Kickoff workshop',
	project_id: 201,
	start_date: '2026-11-10',
	effort_in_minutes: 240,
});
```

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

## What's next

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