Quickstart

Minimal path from zero to a working Public API call.

1. Create an API key

1. Sign in at app.notiq.io.
2. Open API & MCP → /api-mcp.
3. 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.

6. (Optional) MCP

Point Cursor / Claude at https://mcp.notiq.io with the same API key. Tools mirror REST 1:1 — see MCP.

Next