Skip to main content
Use Help Scout through Corsair: one client, typed API calls. Authentication. Help Scout has no API keys: every token comes from a Help Scout app (Your Profile > My Apps) and lasts 2 days. Two ways to connect. oauth_2 (default): each Help Scout account authorizes through an OAuth app, Corsair’s or your own; Corsair renews the token with the stored refresh token. api_key: connect one Help Scout account with its own app by storing the app’s App ID as client_id and App Secret as client_secret (no redirect URL needed): pnpm corsair setup --plugin=helpscout client_id=<app-id> client_secret=<app-secret>, or the Client ID and Client secret fields of Hub’s connect page, with the API key field left empty. The plugin mints a token with Help Scout’s client-credentials grant, keeps it in api_key and mints a new one before it expires. Either way, a read that gets a 401 renews the token once and retries; a write that gets a 401 fails and is not retried. Passing key in plugin options sends that token as is, with no renewal. Rate Limiting. The Mailbox API enforces rate limits per tenant. Corsair’s HTTP transport retries a 429 up to three times, honoring Retry-After. Resource Identification. Help Scout numeric IDs are integers or digit strings. Path parameters accept both numbers and numeric strings. What you get:
  • 55 typed API operations

Setup

1

Install

2

Add the plugin

corsair.ts
With multiTenancy: true, scope calls with corsair.withTenant(id). See Quick start for KEK + Hub keys, and Multi-tenancy for account isolation.
3

Choose authentication

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.

Example API calls

List mailboxes
Delete a conversation
See the full list on the API page.

What’s next

API reference

Every helpscout.api.* operation with input and output types.

Connect / OAuth

createLink, Hub delivery, and tenant connect flows.

Use with agents

Expose this plugin’s operations as MCP tools.