On this page

GET/setup

Credits: None (read-only)
LinkedIn risk: None
Rate limit: Global only

Purpose

Cheap workspace readiness snapshot so an MCP agent does not guess whether LinkedIn is connected, how many agents/campaigns exist, or how many credits remain.

Used by the one-prompt agent-setup runbook before creating a first campaign.

Request

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

No query params.

Response 200

{
  "accounts": {
    "total": 2,
    "connected": 1,
    "hasConnectedAccount": true
  },
  "templates": {
    "total": 3
  },
  "campaigns": {
    "total": 5,
    "byStatus": {
      "READY_TO_SEND": 2,
      "CAMPAIGN_IN_PROGRESS": 1,
      "CAMPAIGN_PAUSED": 1,
      "FAILED": 0,
      "DONE": 0,
      "COMPLETED": 0,
      "other": 1
    }
  },
  "credits": {
    "credits": 842,
    "topUpCredits": 200,
    "lookalikeCredits": 100,
    "lookalikeTopUpCredits": 0,
    "planId": "pro"
  }
}

Field	Notes
`accounts.connected`	Status maps to public `connected` (`connected` / `creation_success` / `reconnected`)
`accounts.hasConnectedAccount`	`connected > 0` — if false, mint a connect link and stop (do not invent account ids)
`templates.total`	Count of agents / templates
`campaigns.byStatus`	Counts for known statuses; remainder → `other`
`credits`	Same shape as `GET /credits` (includes Lookalike)

MCP

Tool: get_setup_status.