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.

Route table

Method	Path	Credits	Docs
GET	`/credits`	0	Open
GET	`/accounts`	0	Open
GET	`/campaigns`	0	Open
POST	`/campaigns`	0 launch; −1/email lead async	Open
GET	`/campaigns/:campaignId`	0	Open
POST	`/campaigns/:campaignId/start`	0	Open
POST	`/campaigns/:campaignId/pause`	0	Open
GET	`/campaigns/:campaignId/leads`	0	Open
GET	`/campaigns/:campaignId/leads/:leadId`	0	Open
POST	`/campaigns/:campaignId/leads`	1 on created	Open
PATCH	`/campaigns/:campaignId/leads/:leadId`	0	Open
POST	`/inbox/messages`	0	Open

Status	Meaning
`CREATED`	Maps launch accepted; discovery may still be running
`READY_TO_SEND`	Leads ready — start with `POST …/start` + `templateId`
`CAMPAIGN_IN_PROGRESS`	Outreach sending — can `pause`
`CAMPAIGN_PAUSED`	Paused — `POST …/start` resumes
Other pipeline values	May appear during discovery / completion; treat as opaque if unknown

Agents/templates (templateId) are created in the NotiQ app UI, then referenced by id from the API.