On this page

Quickstart

Minimal path from zero to a working Public API call.

1. Create an API key

Sign in at app.notiq.io.
Open API & MCP → /api-mcp.
Create a key and copy the secret once (sk_live_…).

Paid (or eligible white-label) access is required — otherwise calls return 403 plan_required.

2. Check credits

export BASE=https://api.notiq.io/public/v1
export KEY=sk_live_…
curl -sS "$BASE/credits" -H "X-API-Key: $KEY"

Expected: { "credits", "topUpCredits", "planId" } plus header X-Request-Id.

3. List accounts and campaigns

curl -sS "$BASE/accounts" -H "X-API-Key: $KEY"
curl -sS "$BASE/campaigns" -H "X-API-Key: $KEY"

Connect Gmail and create agents/templates in the app before starting outreach via API.

4. Launch a Maps campaign (optional)

curl -sS -X POST "$BASE/campaigns" \
  -H "X-API-Key: $KEY" \
  -H "Content-Type: application/json" \
  -d '{"userQuery":"dentists in Austin TX","numberOfSearch":25}'

Poll GET /campaigns/:id and GET /campaigns/:id/leads while discovery runs. Credits debit as email leads are stored.

5. Add a lead by email

curl -sS -X POST "$BASE/campaigns/YOUR_CAMPAIGN_ID/leads" \
  -H "X-API-Key: $KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: demo-1" \
  -d '{"email":"jane@acme.com","fullName":"Jane Doe"}'

status: "created" → creditsCharged: 1.

For many emails, prefer POST …/leads/batch (max 100 per call, 1 credit per create) — see POST …/leads/batch.

6. (Optional) Activity & insights

curl -sS "$BASE/activity?type=reply_received&limit=10" -H "X-API-Key: $KEY"
curl -sS "$BASE/insights/overview" -H "X-API-Key: $KEY"

7. (Optional) Batch leads

# Batch add (1 credit per created)
curl -sS -X POST "$BASE/campaigns/YOUR_CAMPAIGN_ID/leads/batch" \
  -H "X-API-Key: $KEY" -H "Content-Type: application/json" \
  -H "Idempotency-Key: demo-batch-1" \
  -d '{"leads":[{"email":"jane@acme.com","fullName":"Jane Doe"}]}'

# List excluded
curl -sS "$BASE/campaigns/YOUR_CAMPAIGN_ID/leads?excluded=true&limit=5" -H "X-API-Key: $KEY"

# Batch update (0 credits)
curl -sS -X POST "$BASE/campaigns/YOUR_CAMPAIGN_ID/leads/batch-update" \
  -H "X-API-Key: $KEY" -H "Content-Type: application/json" \
  -H "Idempotency-Key: demo-batch-update-1" \
  -d '{"updates":[{"leadId":"lead_1","excluded":true}]}'

# Batch delete (0 credits, irreversible — confirm first)
curl -sS -X POST "$BASE/campaigns/YOUR_CAMPAIGN_ID/leads/batch-delete" \
  -H "X-API-Key: $KEY" -H "Content-Type: application/json" \
  -H "Idempotency-Key: demo-batch-delete-1" \
  -d '{"leadIds":["lead_1"]}'

See POST …/leads/batch, POST …/leads/batch-update, and POST …/leads/batch-delete for field tables and soft statuses.

Point Cursor / Claude at https://mcp.notiq.io with the same API key. Tools mirror REST 1:1 (including add_leads_batch, update_leads_batch, delete_leads_batch, get_recent_activity, get_insights_overview) — see MCP.

Topic	Doc
Full route list	Endpoints
Copy-paste samples	Examples
MCP / Cursor	MCP, Connect MCP
Claude / ChatGPT	Connect Claude / ChatGPT
Errors & limits	Errors, Credits & rate limits
Webhooks	Webhooks
Auth details	Authentication