# SendPilot API

- [SendPilot API and MCP](https://docs.sendler.ai/index.md): Integrate through REST, connect AI clients with API keys or OAuth, and receive workspace webhooks.
- [API Reference](https://docs.sendler.ai/api-reference/introduction.md): The generated public REST API contract for workspaces, campaigns, leads, inbox, quotas, credits, and sourcing.
- [Authentication and permissions](https://docs.sendler.ai/api-reference/authentication.md): Workspace API keys, effective scopes, membership, and the difference between REST and MCP OAuth.
- [Limits, pagination, and retries](https://docs.sendler.ai/api-reference/behavior.md): Handle REST quotas, subscription states, durable idempotency, pagination, and uncertain provider outcomes.
- [MCP Server](https://docs.sendler.ai/ai/mcp.md): Connect your AI assistant to your SendPilot workspace to work with campaigns, leads, inbox conversations, and lead sourcing.
- [Supported clients and setup](https://docs.sendler.ai/ai/mcp-clients.md): Choose remote OAuth or API-key setup, including native Claude Desktop OAuth and an optional legacy local bridge.
- [OAuth connections](https://docs.sendler.ai/ai/mcp-oauth.md): Connect Claude, ChatGPT and Grok with workspace-bound OAuth, review consent, verify use, and manage access.
- [MCP tool reference](https://docs.sendler.ai/ai/mcp-tools.md): Generated tool arguments, scopes, approvals and limits from the SendPilot MCP catalog.
- [Get Workspace and Key](https://docs.sendler.ai/api-reference/endpoint/get-me.md): Inspect the authenticated workspace, subscription, effective scopes, expiry, and rate limits.
- [Get Credit Balance](https://docs.sendler.ai/api-reference/endpoint/get-credits.md): Read the unified available, subscription, purchased and used credits.
- [List Campaigns](https://docs.sendler.ai/api-reference/endpoint/get-campaigns.md): List workspace campaigns, status, and outreach counts.
- [Get Campaign](https://docs.sendler.ai/api-reference/endpoint/get-campaign-by-id.md): Inspect one campaign belonging to the API key's workspace.
- [Pause or Resume Campaign](https://docs.sendler.ai/api-reference/endpoint/patch-campaign.md): Pause outreach or resume an existing paused campaign.
- [List Campaign Leads](https://docs.sendler.ai/api-reference/endpoint/get-leads.md): Page through leads for a required campaign ID.
- [Get Lead](https://docs.sendler.ai/api-reference/endpoint/get-lead-by-id.md): Read a campaign lead and its profile/contact details.
- [Add Leads](https://docs.sendler.ai/api-reference/endpoint/post-add-leads.md): Import 1–1,000 profiles into an existing campaign, with duplicate and validation results.
- [Update Lead Status](https://docs.sendler.ai/api-reference/endpoint/patch-lead-status.md): Set a lead outcome and/or CRM categorization.
- [List Active Senders](https://docs.sendler.ai/api-reference/endpoint/get-senders.md): List active LinkedIn sender accounts for this workspace.
- [Get Sender Quotas](https://docs.sendler.ai/api-reference/endpoint/get-sender-quotas.md): Inspect sender status and daily message, connection-request, and like capacity.
- [List Conversations](https://docs.sendler.ai/api-reference/endpoint/get-conversations.md): Read workspace conversations, optionally filtered by sender account.
- [Get Conversation Messages](https://docs.sendler.ai/api-reference/endpoint/get-messages.md): Read messages for a conversation and its required sender account.
- [Send LinkedIn Message](https://docs.sendler.ai/api-reference/endpoint/post-send-message.md): Send a message from a workspace sender to a LinkedIn profile.
- [Send Message to Lead](https://docs.sendler.ai/api-reference/endpoint/post-send-to-lead.md): Send a message to an existing campaign lead using its stored recipient.
- [Send Connection Request](https://docs.sendler.ai/api-reference/endpoint/post-connect.md): Request a LinkedIn connection from a workspace sender.
- [Discover Lead Filters](https://docs.sendler.ai/api-reference/endpoint/get-lead-filters.md): List supported filter schemas and search or paginate all bundled filter values without spending credits.
- [Start Lead Database Search](https://docs.sendler.ai/api-reference/endpoint/post-lead-database-search.md): Start a paid background search and retain its job ID for polling.
- [Get Search Status](https://docs.sendler.ai/api-reference/endpoint/get-lead-database-search-status.md): Read a search job's state, progress, completion time and errors.
- [Get Search Results](https://docs.sendler.ai/api-reference/endpoint/get-lead-database-search-results.md): Read paginated leads found by a database search.
- [Start Lead Extraction](https://docs.sendler.ai/api-reference/endpoint/post-lead-extractor-campaign.md): Start an extraction job from LinkedIn or Sales Navigator search URLs.
- [Get Extraction Status](https://docs.sendler.ai/api-reference/endpoint/get-lead-extractor-campaign-status.md): Read extraction progress and terminal state.
- [Get Extracted Leads](https://docs.sendler.ai/api-reference/endpoint/get-lead-extractor-campaign-results.md): Read paginated extraction results, optionally restricted to enriched profiles.
- [Webhooks overview](https://docs.sendler.ai/webhooks/overview.md): Workspace event names, Svix delivery, signature verification and replay handling.
- [Set up webhooks](https://docs.sendler.ai/webhooks/setup.md): Create a workspace subscription and verify incoming events with the Svix library.
- [message.sent](https://docs.sendler.ai/webhooks/events/message-sent.md): Triggered when a message is sent to a lead
- [reply.received](https://docs.sendler.ai/webhooks/events/reply-received.md): Triggered when a reply is received from a lead
- [connection_request.sent](https://docs.sendler.ai/webhooks/events/connection-request-sent.md): Triggered when a connection request is sent to a lead
- [connection_request.accepted](https://docs.sendler.ai/webhooks/events/connection-request-accepted.md): Triggered when a lead accepts your connection request
- [lead.updated](https://docs.sendler.ai/webhooks/events/lead-updated.md): Triggered when a lead's status changes
- [Lead tag updated](https://docs.sendler.ai/webhooks/events/lead-tag-updated.md): Understand lifecycle-status and custom CRM-tag changes in lead.tag.updated.
- [campaign.started](https://docs.sendler.ai/webhooks/events/campaign-started.md): Triggered when a campaign is started
- [campaign.paused](https://docs.sendler.ai/webhooks/events/campaign-paused.md): Triggered when a campaign is paused
- [campaign.resumed](https://docs.sendler.ai/webhooks/events/campaign-resumed.md): Triggered when a paused campaign is resumed
- [Campaign finished](https://docs.sendler.ai/webhooks/events/campaign-finished.md): Handle a campaign.finished workspace event.
- [lead_database.search.completed](https://docs.sendler.ai/webhooks/events/lead-database-search-completed.md): Triggered when a Lead Database search completes
- [lead_extractor.job.completed](https://docs.sendler.ai/webhooks/events/lead-extractor-job-completed.md): Triggered when a Lead Extractor campaign completes
- [Use Cases](https://docs.sendler.ai/use-cases/overview.md): Integrate SendPilot with your favorite automation tools
- [Zapier integration](https://docs.sendler.ai/use-cases/zapier.md): Use workspace events and authenticated REST requests in a Zap.
- [n8n integration](https://docs.sendler.ai/use-cases/n8n.md): Build workspace event and REST workflows with scoped credentials and safe retries.
- [Make.com integration](https://docs.sendler.ai/use-cases/make.md): Map SendPilot events and REST actions into Make scenarios.

## OpenAPI Specs

- [openapi](/api-reference/openapi.yaml)
- [sendpilot](/public/schemas/sendpilot.yaml)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.