NotiQNotiQ API
API key
On this page

GET/setup

Cheap workspace readiness check. One call shows whether you have a connected mailbox, any agents, campaign tallies, and credits.

0 credits. Rate class: global.

Request

GET /setup
X-API-Key: sk_live_...

curl -sS -H "X-API-Key: $KEY" "https://api.notiq.io/public/v1/setup"

Response

{
  "accounts": { "total": 2, "connected": 1, "hasConnectedAccount": true },
  "templates": { "total": 3 },
  "campaigns": {
    "total": 5,
    "byStatus": {
      "READY_TO_SEND": 1,
      "CAMPAIGN_IN_PROGRESS": 2,
      "CAMPAIGN_PAUSED": 0,
      "FAILED": 0,
      "DONE": 1,
      "COMPLETED": 0,
      "other": 1
    }
  },
  "credits": { "credits": 120, "topUpCredits": 0, "planId": "starter" }
}
FieldNotes
accounts.connectedSending accounts in a connected-like state and not inactive
templates.totalAll agents (manual and Full Auto)
campaigns.byStatusKnown statuses tallied; anything else rolls into other
credits.planIdWorkspace plan id, or "free" when none

MCP

Tool: get_setup_status.