NotiQNotiQ API
API key
On this page

Quickstart with curl

Replace BASE and KEY as needed.

BASE=https://api.notiq.io/public/v1
KEY=sk_live_your_key_here

All requests need X-API-Key. Responses include X-Request-Id.

Credits

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

Launch Maps campaign

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

Add 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"}'

Start outreach

curl -sS -X POST "$BASE/campaigns/YOUR_CAMPAIGN_ID/start" \
  -H "X-API-Key: $KEY" \
  -H "Content-Type: application/json" \
  -d '{"templateId":"tmpl_abc"}'

Error shape

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid API key.",
    "details": {}
  }
}

See Errors for codes, Endpoints for full contracts, and Quickstart for the guided path.