# NotiQ API

> Public API + MCP reference for NotiQ Google Maps outreach automation.

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

## Pages

- [Introduction](https://docs.notiq.io): NotiQ Public API and MCP — Google Maps lead discovery, campaigns, leads, Gmail, and webhooks.
- [Authentication](https://docs.notiq.io/authentication): Authenticate with X-API-Key (sk_live_…). Keys are created at /api-mcp.
- [Changelog](https://docs.notiq.io/changelog): Notable changes to the NotiQ Public API and this documentation.
- [Connect Claude / ChatGPT](https://docs.notiq.io/connect-claude): Connect Claude.ai, Claude Desktop, or ChatGPT to NotiQ MCP — paste your API key on NotiQ’s consent page, not in OAuth Client ID/Secret.
- [Credits & rate limits](https://docs.notiq.io/credits-and-rate-limits): Credit costs, RPM classes, idempotency, and pagination for the Public API.
- [Endpoints](https://docs.notiq.io/endpoints): NotiQ Public API v1 route index — base URL, auth, and links to every operation.
- [GET /accounts](https://docs.notiq.io/endpoints/get-accounts): List connected Gmail accounts for the workspace.
- [GET /campaigns/:campaignId](https://docs.notiq.io/endpoints/get-campaign): Get a single campaign by id.
- [GET /campaigns](https://docs.notiq.io/endpoints/get-campaigns): List campaigns with optional status filter and cursor pagination.
- [GET /credits](https://docs.notiq.io/endpoints/get-credits): Return remaining credits for the workspace.
- [GET /campaigns/:campaignId/leads/:leadId](https://docs.notiq.io/endpoints/get-lead): Get a single lead by id.
- [GET /campaigns/:campaignId/leads](https://docs.notiq.io/endpoints/get-leads): List leads in a campaign with optional filters and pagination.
- [PATCH /campaigns/:campaignId/leads/:leadId](https://docs.notiq.io/endpoints/patch-lead): Update lead tag or excluded flag. Zero credits.
- [POST /campaigns/:campaignId/leads](https://docs.notiq.io/endpoints/post-add-lead): Add a lead by email. Charges 1 credit when status is created.
- [POST /campaigns](https://docs.notiq.io/endpoints/post-campaigns): Launch a Google Maps search campaign. Discovery continues asynchronously.
- [POST /campaigns/:campaignId/pause](https://docs.notiq.io/endpoints/post-pause-campaign): Pause a campaign in CAMPAIGN_IN_PROGRESS. Zero credits.
- [POST /inbox/messages](https://docs.notiq.io/endpoints/post-send-message): Send or reply via connected Gmail. Zero credits; irreversible.
- [POST /campaigns/:campaignId/start](https://docs.notiq.io/endpoints/post-start-campaign): Start or resume campaign outreach. Zero credits.
- [Errors](https://docs.notiq.io/errors): Error envelope, codes, and how to branch on error.code for the NotiQ Public API.
- [MCP](https://docs.notiq.io/mcp): NotiQ MCP tools mirror Public REST 1:1 — host, auth, tool map, and Cursor config.
- [Quickstart](https://docs.notiq.io/quickstart): Create a key, check credits, list campaigns, and make your first Public API calls.
- [Webhooks](https://docs.notiq.io/webhooks): Outbound NotiQ webhooks — reply.received, lead.tagged, account.disconnected with static X-Webhook-Signature.
- [Connect MCP (Cursor)](https://docs.notiq.io/examples/mcp-connect): Cursor mcp.json snippet for NotiQ MCP with X-API-Key.
- [Quickstart with curl](https://docs.notiq.io/examples/quickstart-curl): Copy-paste curl samples for credits, campaigns, leads, and inbox.

## 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).