Skip to main content
Use PersistIQ through Corsair: one client, typed API calls. Authenticate with the API key from the PersistIQ integrations settings (Settings > Integrations > API Key); the plugin sends it in the x-api-key header. List operations answer { status, errors, has_more, next_page } plus a named array (leads, campaigns, campaign_leads, replies, events, …). Pages are numbered: pass page: 2, 3, … while has_more is true. Lead attributes live in a data map keyed by the account’s lead fields (read them with leadFields.list); leads.create takes them in lead. Adding a lead to a campaign (campaigns.addLead) starts the campaign’s automated emails to that lead, so it is marked destructive like a send (permission modes that pause destructive calls ask before it runs). PersistIQ delivers outbound webhooks through its webhook plugin; the plugin reads and updates those settings (webhooks.getSettings and webhooks.updateSettings). The delivery signature scheme is not documented, so this plugin does not receive the deliveries. Every operation is described in the official OpenAPI spec: https://persistiq.com/api-docs/v1/swagger.json What you get:
  • 21 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

Read a lead
Create a lead
See the full list on the API page.

What’s next

API reference

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