# ScaliQ API

> Public API + MCP reference for ScaliQ outreach automation.

Base URL: https://api.scaliq.ai/public/v1
MCP: https://mcp.scaliq.ai
Auth header: X-API-Key: sk_live_…
Keys: https://app.scaliq.ai/api-mcp
OpenAPI: https://docs.scaliq.ai/openapi.yaml
Docs: https://docs.scaliq.ai
Sitemap: https://docs.scaliq.ai/sitemap.xml

## Pages

- [Introduction](https://docs.scaliq.ai): ScaliQ Public API and MCP — feed leads, start and pause campaigns, search LinkedIn, send messages, and receive reply webhooks.
- [Authentication](https://docs.scaliq.ai/authentication): Authenticate ScaliQ Public API requests with X-API-Key. Key prefix, plan requirements, and common auth errors.
- [Changelog](https://docs.scaliq.ai/changelog): ScaliQ Public API and MCP release notes and breaking changes.
- [Connect Claude / ChatGPT](https://docs.scaliq.ai/connect-claude): Connect Claude.ai, Claude Desktop, or ChatGPT to ScaliQ MCP — paste your API key on ScaliQ’s consent page, not in OAuth Client ID/Secret.
- [Credits & rate limits](https://docs.scaliq.ai/credits-and-rate-limits): ScaliQ API credit costs per action and rate limit headers for the Public API and MCP.
- [Endpoints](https://docs.scaliq.ai/endpoints): Complete ScaliQ Public API endpoint reference — credits, accounts, campaigns, start/pause, leads, messaging, and LinkedIn lookup/search.
- [GET /accounts](https://docs.scaliq.ai/endpoints/get-accounts): List connected LinkedIn accounts and accountId values for search, lookup, and send.
- [GET /campaigns/:campaignId](https://docs.scaliq.ai/endpoints/get-campaign): Fetch a single campaign by id with the same fields as the campaign list.
- [GET /campaigns](https://docs.scaliq.ai/endpoints/get-campaigns): Paginated list of ScaliQ campaigns for the authenticated workspace.
- [GET /credits](https://docs.scaliq.ai/endpoints/get-credits): Check remaining ScaliQ API credits and plan id for your workspace.
- [GET /campaigns/:campaignId/leads/:leadId](https://docs.scaliq.ai/endpoints/get-lead): Fetch lead detail including list fields and extra lead properties.
- [GET /campaigns/:campaignId/leads](https://docs.scaliq.ai/endpoints/get-leads): Paginated leads for a campaign. Filter by tag, replied, or needsReply.
- [PATCH /campaigns/:campaignId/leads/:leadId](https://docs.scaliq.ai/endpoints/patch-lead): Update a lead inbox tag and/or excluded flag. Provide at least one field.
- [POST /campaigns/:campaignId/leads](https://docs.scaliq.ai/endpoints/post-add-lead): Add a LinkedIn profile to a campaign. Charges 1 credit when status is created.
- [POST /linkedin/profiles/lookup](https://docs.scaliq.ai/endpoints/post-linkedin-lookup): Live LinkedIn profile lookup by URL. Zero credits; strict rate limits apply.
- [POST /linkedin/search](https://docs.scaliq.ai/endpoints/post-linkedin-search): One page of LinkedIn people search. Zero credits; strict rate limits apply.
- [POST /campaigns/:campaignId/pause](https://docs.scaliq.ai/endpoints/post-pause-campaign): Pause in-progress ScaliQ campaign outreach. Same as dashboard Pause. Zero credits.
- [POST /inbox/messages](https://docs.scaliq.ai/endpoints/post-send-message): Send a LinkedIn DM to an existing campaign lead (synchronous).
- [POST /campaigns/:campaignId/start](https://docs.scaliq.ai/endpoints/post-start-campaign): Start or resume ScaliQ campaign outreach. Same as dashboard Start / Resume. Zero credits.
- [Errors](https://docs.scaliq.ai/errors): ScaliQ API error response shape and error.code values. Branch on code, not HTTP status alone.
- [MCP](https://docs.scaliq.ai/mcp): Connect Cursor, ChatGPT, or Claude to ScaliQ MCP. Same capabilities as the REST API as tools for coding agents.
- [Quickstart](https://docs.scaliq.ai/quickstart): Create an API key, check credits, and add your first lead with the ScaliQ Public API in a few minutes.
- [Webhooks](https://docs.scaliq.ai/webhooks): Receive ScaliQ reply, accept, and tag events via HTTPS webhooks. Payload shape and optional X-ScaliQ-Signature header auth.
- [Example — verify webhook signature](https://docs.scaliq.ai/examples/hmac-verify): Verify ScaliQ webhook X-ScaliQ-Signature header against your static signing secret.
- [Example — MCP connect](https://docs.scaliq.ai/examples/mcp-connect): Connect ChatGPT to ScaliQ MCP with mcp.json and an API key.
- [Example — quickstart curl](https://docs.scaliq.ai/examples/quickstart-curl): Copy-paste curl examples for credits, campaigns, add-lead, start, and pause.

## Notes

- Branch on error.code, not HTTP status alone.
- Unknown JSON keys are rejected.
- Webhook subscriptions are configured in the dashboard.
- Prefer MCP tools for coding agents (ChatGPT, Claude).