Endorsal plugin

Use Endorsal through Corsair: one client, typed API calls. Generate a property-specific key at https://app.endorsal.io/account/api. The plugin sends it as Authorization: Bearer <key> on every call. The reference marks GET keys as optional, but the API answers 401 to every route without one, so the plugin asks for a key before any call. The plugin uses the API host https://api.endorsal.io and never puts credentials in query parameters. The published OpenAPI document currently defines 25 REST operations. List routes return the complete collection and expose no page or cursor parameters. Search conditions are AND-combined; in requires an array. Testimonial status fields (approved, featured) are numeric. widgets.byId.get and wallOfLove.get support render: true, which returns rendered HTML rather than the normal JSON resource. The POST /superlinks route is not present in the current published OpenAPI document, so it is intentionally excluded. Webhooks are outside this integration’s scope. What you get:

25 typed API operations

Setup

Install

npm install corsair @corsair-dev/endorsal better-sqlite3
npm install --save-dev @types/better-sqlite3

yarn add corsair @corsair-dev/endorsal better-sqlite3
yarn add --dev @types/better-sqlite3

pnpm install corsair @corsair-dev/endorsal better-sqlite3
pnpm install --save-dev @types/better-sqlite3

bun add corsair @corsair-dev/endorsal better-sqlite3
bun add --dev @types/better-sqlite3

Add the plugin

corsair.ts

import Database from 'better-sqlite3';
import { createCorsair } from 'corsair';
import { endorsal } from '@corsair-dev/endorsal';

export const corsair = createCorsair({
	plugins: [
		endorsal(),
	],
	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 for KEK + Hub keys, and Multi-tenancy for account isolation.

Choose authentication

API Key (Recommended)

Store the Endorsal API key before the first call: pnpm corsair setup --plugin=endorsal --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.

endorsal()

More: API Key

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.

const { connectUrl } = await corsair.manage.connect.createLink({
	plugin: 'endorsal',
	tenantId: 'acme',
});
// redirect the user's browser to connectUrl

Example API calls

autorequests.campaigns.byId.get

const tenant = corsair.withTenant('acme');
await tenant.endorsal.api.autorequests.campaigns.byId.get({ id: 'campaign_123' });

contacts.byId.delete

const tenant = corsair.withTenant('acme');
await tenant.endorsal.api.contacts.byId.delete({ id: 'contact_123' });

See the full list on the API page.

What’s next

API reference

Every endorsal.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.

Overview

Plugins