connectzly

Get credits

GET /credits — remaining lead credits, Lookalike balance (lookalikeCredits), and plan id. Free (0 credits).

List LinkedIn accounts

GET /accounts — paginated list of connected accounts (id, status, active, hasSalesNavigator) plus today's per-account usage and caps in `today` (connectionRequestsSent/Accepted, messagesSent, and their limits; UTC-day reset). Check usage against the limits before sending. Follow `nextCursor` when it is not null.

List campaigns

GET /campaigns — paginated campaign list. Each item includes `stats` (connectionRequestsSent/Accepted, acceptanceRate, messagesSent, repliesReceived, replyRate), so campaign performance needs no per-campaign fetch. Rates are percentages and are null when the denominator is 0.

Get campaign

GET /campaigns/:campaignId — one campaign with its stats. Free (0 credits).

Insights overview

GET /insights/overview — marketing snapshot for this workspace. Returns highlights (lastActivityAt, lastReplyAt + lead/campaign), lifetime workspace counters, and top campaigns by replyRate / acceptanceRate among up to 100 most recently updated campaigns (see campaignsSampled / campaignsSampleCapped — not all-time). For Interested people use list_leads(tag="Interested"), not this tool. Free (0 credits).

Recent activity

GET /activity — recent outreach events (allowlisted types only). Use type=reply_received for “when did I get the last reply?”. Fields: type, timestamp, leadId, leadName, companyName, campaignId, optional messagePreview (≤80 chars, often null), handOffReason. Not a full inbox or Firestore dump. Free (0 credits).

Start campaign

POST /campaigns/:campaignId/start — start READY_TO_SEND (or FAILED with leads), resume PAUSED, noop if already in progress. Agent must be assigned in the dashboard. Free (0 credits). Confirm with the user before starting real outreach.

Pause campaign

POST /campaigns/:campaignId/pause — pause an in-progress campaign (noop if already paused). Free (0 credits).

Create Lookalike campaign

POST /campaigns/lookalike — create (or extend with campaignId) an async Lookalike campaign from a LinkedIn profile URL or identifier. Spends Lookalike allowance (see get_credits.lookalikeCredits), not normal lead credits. Optional jobTitleKeywords (include titles, partial match) strongly improves role relevance. Optional countries (ISO alpha-2, e.g. ["us","gb"]) limits people to those locations. Website/domain seeds are rejected. Poll GET /campaigns/:id and leads until READY_TO_SEND. Optional Id

List leads

GET /campaigns/:campaignId/leads — allowlisted CRM fields only (not a full DB doc): id, fullName, firstName, lastName, linkedinUrl, jobTitle, location, companyName, companyLinkedin, website, email, tag, replied, needsReply, excluded, stage, repliedAt, lastInboundMessageAt, taggedAt. At most one of tag / replied / needsReply / excluded. excluded must be true when used (false is not supported). Optional sort (always desc): createdAt (default), taggedAt (requires tag), repliedAt (requires replied),

Get lead

GET /campaigns/:campaignId/leads/:leadId — list-lead allowlisted fields plus headline, workExperience (max 10), connectionRequestAccepted, messageSent. Use list_leads for Interested / needsReply filters. For last inbound reply time prefer lastInboundMessageAt or get_recent_activity(type=reply_received), not message logs (those are never returned). Free (0 credits).

Add lead

POST /campaigns/:campaignId/leads — insert by LinkedIn URL (1 credit on create). Optional profile fields.

Add leads (batch)

POST /campaigns/:campaignId/leads/batch — insert up to 100 LinkedIn URLs in one call (1 credit per create). Returns per-item results; chunk larger lists client-side.

Update lead

PATCH /campaigns/:campaignId/leads/:leadId — set tag and/or excluded. Free (0 credits). For many leads use update_leads_batch.

Update leads (batch)

POST /campaigns/:campaignId/leads/batch-update — set tag and/or excluded for up to 100 leads (0 credits). Exclude is immediate and workspace-global (no polite-ack defer). Chunk larger lists. Prefer this over many update_lead calls.

Delete leads (batch)

POST /campaigns/:campaignId/leads/batch-delete — permanently delete up to 100 campaign leads. Irreversible; no credit refund. Confirm with the user first. Retry of already-deleted ids returns not_found (safe). Chunk larger lists.

Send LinkedIn message

POST /inbox/messages — sends a REAL LinkedIn DM to an existing campaign lead (text only), immediately and irreversibly. There is no unsend. Confirm the recipient and the exact text with the user before calling. Free (0 credits) but it spends the account's daily send allowance — check `today` from list_accounts first.

Lookup LinkedIn profile

POST /linkedin/profiles/lookup — clean profile DTO (does not add a lead). Accepts messy /in/…?miniProfileUrn=… URLs (tracking params stripped). Returns firstName/lastName, website, companyLinkedin, and current jobTitle/companyName. Pass depth:"full" for about + experience[] (role history with dates/descriptions). Free (0 credits) but each call spends the connected account's LinkedIn lookup quota (~80–150/day) — do not loop over large lists.

Search LinkedIn

POST /linkedin/search — one sync page (classic or sales_nav). Provide exactly one of query or url. jobTitle/companyName are only set when LinkedIn returns a structured current role — otherwise they are null and headline stays the free-text line. Use lookup_profile (depth full) for reliable title/company/experience. Free (0 credits) but each page spends the account's LinkedIn search quota — page deliberately, do not burst.