NotiQNotiQ API
API key
On this page

Endpoints

Base URL: https://api.notiq.io/public/v1

Auth on every request: X-API-Key: sk_live_… (not Bearer). Success responses are bare JSON. Always returned: X-Request-Id.

MCP exposes 48 tools for these routes (plus MCP-only wait_for_campaign_leads) — see MCP and Agent setup.

Route table

Core

MethodPathCreditsDocs
GET/credits0Open
GET/accounts0Open
POST/tools/validate-email0 or 1 (full validation API hit)Open
POST/tools/validate-emailssum of per-item rulesOpen
POST/tools/enrich-website0Open
GET/activity0Open
GET/insights/overview0Open
GET/campaigns0Open
POST/campaigns0 launch; −1/email lead asyncOpen
GET/campaigns/:campaignId0Open
POST/campaigns/:campaignId/start0Open
POST/campaigns/:campaignId/pause0Open
GET/campaigns/:campaignId/leads0Open
GET/campaigns/:campaignId/leads/:leadId0Open
POST/campaigns/:campaignId/leads1 on createdOpen
POST/campaigns/:campaignId/leads/batch1 per createdOpen
PATCH/campaigns/:campaignId/leads/:leadId0Open
POST/campaigns/:campaignId/leads/batch-update0Open
POST/campaigns/:campaignId/leads/batch-delete0 (no refund)Open
POST/inbox/messages0Open

Setup + agents

MethodPathCreditsDocs
GET/setup0Open
GET/templates0Open
GET/templates/:id0Open
POST/templates0Open
PATCH/templates/:id0Open
DELETE/templates/:id0Open
POST/campaigns/:id/template0Open

Tags + goals

MethodPathCreditsDocs
GET / POST / PATCH/tags · /tags/:labelKey0Open
POST/campaigns/:id/overview-goal0Open

Exclude desk

MethodPathCreditsDocs
GET / POST/excluded-leads · /excluded-domains (+ /remove)0Open

Ops + mailbox

MethodPathCreditsDocs
POST/campaigns/manual0Open
PATCH/campaigns/:id0Open
DELETE/campaigns/:id0Open
DELETE/campaigns/:id/leads/:leadId0Open
POST/campaigns/:id/leads/:leadId/agent0Open
POST/campaigns/:id/leads/:leadId/preview0Open
PATCH/accounts/:id0Open
DELETE/accounts/:id0Open
POST/accounts/connect-link · …/reconnect-link0Open

Campaign status values

StatusMeaning
CREATEDMaps launch accepted; discovery may still be running
READY_TO_SENDLeads ready — start with POST …/start + templateId
CAMPAIGN_IN_PROGRESSOutreach sending — can pause
CAMPAIGN_PAUSEDPaused — POST …/start resumes
Other pipeline valuesMay appear during discovery / completion; treat as opaque if unknown

Also check extensionStatus: "FINDING_LEADS" while UI “Add more leads” / file-import extend is running, otherwise null. Parent status may stay READY_TO_SEND during an extend — wait until extensionStatus is null before treating discovery as finished (MCP: wait_for_campaign_leads).

Manual agents can be created via POST /templates (or the dashboard). Assign with POST /campaigns/:id/template. Full Auto agents are list/get/delete only on the Public API.