HeyReach CLI

HeyReach in your terminal. Run LinkedIn automation campaigns, manage leads, lists, conversations, webhooks, and organization settings — from a single command line.

0.2.2 is the agency-profiles release: --profile loads one workspace key; --workspace confirms writes only. It is not full public API coverage. HeyReach Postman now lists 82 endpoints; this CLI still covers the May surface plus fail-closed profiles. Inbox V3, per-campaign stats, org LinkedIn account move, account-login API, and email enrichment are out of 0.2.2 (0.2.3 later).

npm install -g heyreach-cli

What is HeyReach?

HeyReach is a LinkedIn automation platform for outbound sales and lead generation. It manages:

LinkedIn campaigns — multi-step outreach sequences with connection requests, messages, InMails, profile views, and post likes
Lead management — import, tag, and track prospects across campaigns and lists
Multi-account sending — rotate across multiple LinkedIn accounts within a single campaign
Unified inbox — read and reply to LinkedIn conversations across all connected accounts
Webhooks — real-time event notifications for connection accepts, replies, campaign completions, and more
Organization management — workspaces, users, permissions, and API key management at the org level

What This CLI Enables

The May public-API surface, plus agency isolation. Not every HeyReach dashboard or Postman action:

Campaign operations — list, get, pause, resume campaigns. Add leads to campaigns, stop leads mid-sequence, pull lead analytics with status breakdowns.

Lead lifecycle — look up any lead by LinkedIn profile URL, manage tags (add, replace, get), and track which campaigns and lists a lead belongs to.

List management — create lead and company lists, add/remove leads by ID or profile URL, query companies, and search leads within lists with date filters.

Inbox management — existing V2 conversation list/get/send/seen. Inbox V3 is not in 0.2.2.

Webhooks — create, update, and delete webhooks for 12 event types including connection requests, message replies, InMail replies, campaign completions, and tag updates.

Network intelligence — query a sender's LinkedIn network and check connection status with any lead.

Organization admin — manage workspaces, users, API keys, and invite admins/members/managers — all via the Management API.

AI agent integration — every wrapped command is both a CLI subcommand and an MCP tool. Confirm status (slug, workspace id, name) before writes.

See CHANGELOG.md and SKILL.md.

Install

npm (recommended)

npm install -g heyreach-cli

npx (zero-install)

npx heyreach-cli campaigns list

From source

git clone https://github.com/bcharleson/heyreach-cli.git
cd heyreach-cli
npm install && npm run build
npm link

Authentication

Default: one workspace

Resolve order without --profile / HEYREACH_PROFILE:

--api-key flag — pass on any command: heyreach campaigns list --api-key <key>
HEYREACH_API_KEY
cwd .env HEYREACH_API_KEY
Stored config — heyreach login writes ~/.heyreach/config.json ({ api_key }, mode 0600)

Get your API key from your HeyReach workspace settings (Settings → Integrations → Public API). --profile is not required for this path.

export HEYREACH_API_KEY=your-key
heyreach status
# confirm profile, workspace_id, workspace_name, then:
heyreach campaigns list

heyreach login validates the key with GET /auth/CheckApiKey (valid/invalid only — no workspace whoami). Pass --workspace <id> and optional --workspace-name to stamp the bound pair onto default config. Omitted --workspace leaves today's single-key file.

status / whoami print slug (default), workspace id, name, and source. They never print the API key or a prefix.

Agency: named profiles

Agencies (and agents) run multiple workspaces from one machine without mixing clients. Name every client as a profile — including the house org.

heyreach login --profile client-a --api-key "$CLIENT_A_KEY" --workspace 1001 --workspace-name "Client A"
heyreach login --profile client-b --api-key "$CLIENT_B_KEY" --workspace 2002 --workspace-name "Client B"
# writes only ~/.heyreach/profiles/<slug>.json (mode 0600). Never writes config.json.
# never stores org_api_key in a client profile

Then:

export HEYREACH_PROFILE=client-a
heyreach status          # confirm slug + workspace_id + workspace_name
heyreach campaigns list  # POST list — does not require --workspace
heyreach --profile client-a --workspace 1001 campaigns pause --campaign-id 12345

Rails

--profile loads the key. --workspace confirms writes only (numeric id). POST list/read does not need --workspace.
Slug: ^[a-z0-9](?:[a-z0-9-]{0,62}[a-z0-9])?$. default is reserved.
Profile wins over cwd .env and over HEYREACH_API_KEY. Unknown slug aborts.
One process, one profile. No --all-profiles. No WORKSPACE_KEYS.
GET /auth/CheckApiKey cannot whoami — login --profile requires --workspace <id>.
Writes under a profile require --workspace <that same numeric id> and abort (WORKSPACE_MISMATCH / validation) before any HeyReach HTTP mutation.
If --workspace is passed on the default path and default config has a stamped id, they must match. No bound id: do not invent one.
logout --profile client-a deletes only that profile file. Bare logout deletes default config only.
Confirm status printed id + name before any write.

See SKILL.md for agent-oriented rails.

Organization API (admin operations)

Organization commands (heyreach org ...) require a separate Organization API key:

export HEYREACH_ORG_API_KEY=your-org-key
heyreach org workspaces --pretty

Or: heyreach login --org to save the org key, or --org-key <key> per-command. Never store an org key in a client profile.

Quick Start

# Authenticate
heyreach login

# List your campaigns
heyreach campaigns list --pretty

# Get a specific campaign
heyreach campaigns get --campaign-id 12345 --pretty

# List LinkedIn accounts
heyreach accounts list --pretty

# Check lead details
heyreach leads get --profile-url "https://linkedin.com/in/janedoe" --pretty

# Browse inbox
heyreach inbox list --pretty

# Check API key validity
heyreach status

Output Formats

Every command outputs JSON by default — ready for piping to jq, parsing in scripts, or feeding to other tools.

# Default: compact JSON
heyreach campaigns list

# Pretty-printed JSON
heyreach campaigns list --pretty

# Select specific fields
heyreach campaigns list --fields "id,name,status"

# Suppress output (exit code only)
heyreach campaigns list --quiet

Commands

Campaigns (15)

Manage LinkedIn outreach campaigns — including full programmatic creation, sequence design, scheduling, and activation so AI agents can build, launch, and run campaigns end-to-end.

heyreach campaigns list [--keyword <text>] [--statuses <list>] [--account-ids <list>]
heyreach campaigns get --campaign-id <id>
heyreach campaigns start --campaign-id <id>     # DRAFT → IN_PROGRESS
heyreach campaigns resume --campaign-id <id>    # PAUSED / FINISHED / FAILED → IN_PROGRESS
heyreach campaigns pause --campaign-id <id>     # IN_PROGRESS → PAUSED  (only way to halt sending)
heyreach campaigns add-leads --campaign-id <id> --leads-json '<json>'
heyreach campaigns stop-lead --campaign-id <id> [--lead-url <url>] [--lead-member-id <id>]
heyreach campaigns get-leads --campaign-id <id> [--time-from <iso>] [--time-to <iso>] [--time-filter <type>]
heyreach campaigns get-for-lead [--email <e>] [--linkedin-id <id>] [--profile-url <url>]
heyreach campaigns create --name <name> --list-id <id> --account-ids <list> [--schedule-json <json>] [--sequence-json <json>] [--exclude-list-id <id>] [--exclude-contacted-other-campaigns] [--exclude-other-conversations] [--exclude-sender-contacted]
heyreach campaigns update-settings --campaign-id <id> --name <name> --list-id <id> [--exclude-list-id <id>] [--exclude-contacted-other-campaigns] [--exclude-other-conversations] [--exclude-sender-contacted]
heyreach campaigns update-sequence --campaign-id <id> --sequence-json '<json>'
heyreach campaigns update-accounts --campaign-id <id> --account-ids <list>
heyreach campaigns update-schedule --campaign-id <id> --schedule-json '<json>'
heyreach campaigns get-sequence --campaign-id <id>

Campaign creation flow: create returns {campaignId} in DRAFT status. Adjust via update-* commands, then call start to activate. Use pause to halt and resume to continue (resume is rejected on DRAFT campaigns — use start instead). get-sequence returns a reusable PublicSequenceNodeDto — feed its output directly back into create --sequence-json to clone workflows. update-settings, update-sequence, update-accounts, and update-schedule only work on DRAFT / SCHEDULED / PAUSED campaigns. There is no delete / stop / cancel endpoint in the HeyReach API — once created, a campaign exists forever and can only be paused.

Statuses: DRAFT, IN_PROGRESS, PAUSED, FINISHED, CANCELED, FAILED, STARTING, SCHEDULED

Add leads example:

heyreach campaigns add-leads --campaign-id 123 --leads-json '[
  {
    "lead": {
      "firstName": "Jane",
      "lastName": "Doe",
      "profileUrl": "https://linkedin.com/in/janedoe",
      "companyName": "Acme Inc",
      "position": "VP Sales"
    },
    "linkedInAccountId": 456
  }
]'

Inbox (4)

Read and respond to LinkedIn conversations.

heyreach inbox list [--account-ids <list>] [--campaign-ids <list>] [--search <text>] [--tags <list>] [--seen <bool>]
heyreach inbox get --account-id <id> --conversation-id <id>
heyreach inbox send --conversation-id <id> --account-id <id> --message <text> [--subject <text>]
heyreach inbox set-seen --conversation-id <id> --account-id <id> --seen <bool>

LinkedIn Accounts (2)

Manage connected LinkedIn accounts.

heyreach accounts list [--keyword <text>]
heyreach accounts get --account-id <id>

Lists (9)

Manage lead and company lists.

heyreach lists list [--keyword <text>] [--list-type <type>] [--campaign-ids <list>]
heyreach lists get --list-id <id>
heyreach lists create --name <name> [--type <USER_LIST|COMPANY_LIST>]
heyreach lists get-leads --list-id <id> [--keyword <text>] [--profile-url <url>]
heyreach lists add-leads --list-id <id> --leads-json '<json>'
heyreach lists delete-leads --list-id <id> --member-ids <list>
heyreach lists delete-leads-by-url --list-id <id> --urls <list>
heyreach lists get-companies --list-id <id> [--keyword <text>]
heyreach lists get-for-lead [--email <e>] [--linkedin-id <id>] [--profile-url <url>]

List types: USER_LIST (default), COMPANY_LIST

Stats (1)

Pull campaign analytics.

heyreach stats overview --start-date <iso> --end-date <iso> [--account-ids <list>] [--campaign-ids <list>]

Returns day-by-day and overall stats: profile views, messages sent/replied, connections sent/accepted, InMails, reply rates, and acceptance rates.

Leads (4)

Look up and tag individual leads.

heyreach leads get --profile-url <url>
heyreach leads add-tags --tags <list> [--profile-url <url>] [--linkedin-id <id>] [--create-if-missing]
heyreach leads get-tags --profile-url <url>
heyreach leads replace-tags --tags <list> [--profile-url <url>] [--linkedin-id <id>] [--create-if-missing]

Lead Tags (1)

Create workspace-level tags.

heyreach lead-tags create --tags-json '[{"displayName":"Hot","color":"Red"},{"displayName":"Priority","color":"Blue"}]'

Tag colors: Blue, Green, Purple, Pink, Red, Cyan, Yellow, Orange

Webhooks (5)

Subscribe to real-time LinkedIn events.

heyreach webhooks list
heyreach webhooks get --webhook-id <id>
heyreach webhooks create --name <name> --url <url> --event-type <type> [--campaign-ids <list>]
heyreach webhooks update --webhook-id <id> [--name <n>] [--url <u>] [--event-type <t>] [--active <bool>]
heyreach webhooks delete --webhook-id <id>

Event types: CONNECTION_REQUEST_SENT, CONNECTION_REQUEST_ACCEPTED, MESSAGE_SENT, MESSAGE_REPLY_RECEIVED, INMAIL_SENT, INMAIL_REPLY_RECEIVED, EVERY_MESSAGE_REPLY_RECEIVED, FOLLOW_SENT, LIKED_POST, VIEWED_PROFILE, CAMPAIGN_COMPLETED, LEAD_TAG_UPDATED

Network (2)

Query LinkedIn network connections.

heyreach network list --sender-id <id> [--page <n>] [--page-size <n>]
heyreach network check --sender-account-id <id> [--lead-profile-url <url>] [--lead-linkedin-id <id>]

Organization Management (11)

Manage workspaces, users, and API keys. Requires Organization API key (--org-key or HEYREACH_ORG_API_KEY).

heyreach org workspaces [--offset <n>] [--limit <n>]
heyreach org create-workspace --name <name> [--seats-limit <n>]
heyreach org update-workspace --workspace-id <id> [--name <n>] [--seats-limit <n>]
heyreach org api-keys --workspace-id <id>
heyreach org create-api-key --workspace-id <id> --type <PUBLIC|N8N|MAKE|ZAPIER|MCP>
heyreach org users [--role <Admin|Member|Manager>] [--invitation-status <list>]
heyreach org get-user --user-id <id>
heyreach org workspace-users --workspace-id <id> [--role <role>]
heyreach org invite-admins --inviter-email <email> --emails <list>
heyreach org invite-members --inviter-email <email> --emails <list> --workspace-ids <list> --permissions-json '<json>'
heyreach org invite-managers --inviter-email <email> --emails <list> --workspace-ids <list>

Pagination

Most list endpoints use offset/limit pagination in the POST body:

# First page (default: offset=0, limit=100)
heyreach campaigns list

# Second page
heyreach campaigns list --offset 100 --limit 100

# Smaller pages
heyreach campaigns list --offset 0 --limit 25

Response format: { "totalCount": 250, "items": [...] }

Exception: Network commands use --page and --page-size instead of offset/limit.

Common Workflows

Launch a LinkedIn campaign with leads

# 1. Create a lead list
LIST=$(heyreach lists create --name "Q2 Prospects" | jq -r '.id')

# 2. Add leads to the list
heyreach lists add-leads --list-id "$LIST" --leads-json '[
  {"firstName":"Alex","lastName":"Chen","profileUrl":"https://linkedin.com/in/alexchen","companyName":"TechCo","position":"CTO"},
  {"firstName":"Sarah","lastName":"Kim","profileUrl":"https://linkedin.com/in/sarahkim","companyName":"StartupXYZ","position":"VP Sales"}
]'

# 3. Add leads to a campaign (assumes campaign already exists)
heyreach campaigns add-leads --campaign-id 12345 --leads-json '[
  {"lead":{"profileUrl":"https://linkedin.com/in/alexchen"}},
  {"lead":{"profileUrl":"https://linkedin.com/in/sarahkim"}}
]'

# 4. Resume the campaign
heyreach campaigns resume --campaign-id 12345

Monitor replies and conversations

# Check for new conversations
heyreach inbox list --seen false --pretty

# Read a specific conversation
heyreach inbox get --account-id 456 --conversation-id "conv-abc" --pretty

# Reply to a conversation
heyreach inbox send --conversation-id "conv-abc" --account-id 456 --message "Thanks for connecting!"

# Mark as seen
heyreach inbox set-seen --conversation-id "conv-abc" --account-id 456 --seen true

Tag and track leads

# Look up a lead
heyreach leads get --profile-url "https://linkedin.com/in/janedoe" --pretty

# Add tags
heyreach leads add-tags --profile-url "https://linkedin.com/in/janedoe" --tags "hot,enterprise" --create-if-missing

# See which campaigns they're in
heyreach campaigns get-for-lead --profile-url "https://linkedin.com/in/janedoe" --pretty

# See which lists they're on
heyreach lists get-for-lead --profile-url "https://linkedin.com/in/janedoe" --pretty

Set up webhooks for real-time events

# Create a webhook for new replies
heyreach webhooks create --name "Reply Notifications" \
  --url "https://your-endpoint.com/heyreach-hook" \
  --event-type MESSAGE_REPLY_RECEIVED

# Create a webhook for connection accepts
heyreach webhooks create --name "Connection Accepts" \
  --url "https://your-endpoint.com/heyreach-hook" \
  --event-type CONNECTION_REQUEST_ACCEPTED \
  --campaign-ids "123,456"

# List all webhooks
heyreach webhooks list --pretty

Pull campaign analytics

# Overall stats for last 30 days
heyreach stats overview \
  --start-date "2025-01-01T00:00:00Z" \
  --end-date "2025-01-31T23:59:59Z" \
  --pretty

# Stats for specific campaigns
heyreach stats overview \
  --start-date "2025-01-01T00:00:00Z" \
  --end-date "2025-01-31T23:59:59Z" \
  --campaign-ids "123,456" \
  --pretty

Organization administration

# List workspaces (requires org key)
export HEYREACH_ORG_API_KEY=your-org-key
heyreach org workspaces --pretty

# Create a new workspace
heyreach org create-workspace --name "Sales Team" --seats-limit 10

# Invite a member with specific permissions
heyreach org invite-members \
  --inviter-email "admin@company.com" \
  --emails "newuser@company.com" \
  --workspace-ids "123" \
  --permissions-json '{"viewCampaigns":true,"viewLeadLists":true,"viewLinkedInSenderInboxes":true}'

# Generate an API key for a workspace
heyreach org create-api-key --workspace-id 123 --type PUBLIC

MCP Server

The CLI doubles as an MCP (Model Context Protocol) server for the wrapped May surface (plus status / profile isolation). Not the full 82-endpoint Postman collection.

heyreach mcp

What this means

When you configure heyreach mcp as an MCP server in Claude, Cursor, VS Code, or Windsurf, your AI assistant can:

List and manage LinkedIn campaigns mid-conversation
Look up leads, check tags, and browse conversations on demand
Send LinkedIn messages and manage inbox directly
Create webhooks and monitor campaign analytics
Handle org-level admin tasks (workspaces, users, API keys)

Every CommandDefinition in the codebase powers both a CLI subcommand and an MCP tool — one source of truth, two interfaces.

Configuration

Add to your MCP settings (Claude Desktop, Cursor, VS Code, Windsurf):

{
  "mcpServers": {
    "heyreach": {
      "command": "npx",
      "args": ["heyreach-cli", "mcp"],
      "env": {
        "HEYREACH_API_KEY": "your-api-key"
      }
    },
    "heyreach-client-a": {
      "command": "npx",
      "args": ["heyreach-cli", "mcp"],
      "env": {
        "HEYREACH_PROFILE": "client-a"
      }
    }
  }
}

This registers the May-surface tools (plus status). Not Inbox V3, per-campaign stats, org LinkedIn account move, account-login, or email enrichment:

Group	Tools	Examples
Campaigns	14	`campaigns_list`, `campaigns_create`, `campaigns_update_sequence`, `campaigns_get_sequence`
Inbox	4	`inbox_list`, `inbox_get`, `inbox_send`, `inbox_set_seen`
Accounts	2	`accounts_list`, `accounts_get`
Lists	9	`lists_list`, `lists_create`, `lists_add_leads`, `lists_get_companies`
Stats	1	`stats_overview`
Leads	4	`leads_get`, `leads_add_tags`, `leads_get_tags`, `leads_replace_tags`
Lead Tags	1	`lead_tags_create`
Webhooks	5	`webhooks_create`, `webhooks_list`, `webhooks_update`, `webhooks_delete`
Network	2	`network_list`, `network_check`
Org	11	`org_workspaces`, `org_users`, `org_invite_members`, `org_create_api_key`

API Reference

Base URL: https://api.heyreach.io/api/public/
Auth header: X-API-KEY (not Bearer token)
Rate limit: 300 requests/minute (Organization API has its own separate 300 req/min limit)
Pagination: POST body { offset, limit } → response { totalCount, items[] }
Max items per request: 100 (1000 for lead/company list queries)

Full API docs: HeyReach API Documentation

Architecture

Every command is a CommandDefinition — one source of truth powering both the CLI subcommand and the MCP tool:

src/
├── core/
│   ├── types.ts      # CommandDefinition interface
│   ├── client.ts     # HTTP client (X-API-KEY, retry, rate limit, pagination)
│   ├── auth.ts       # API key resolution (flag → env → .env → config; profile wins)
│   ├── config.ts     # ~/.heyreach/config.json (0600)
│   ├── profiles.ts   # ~/.heyreach/profiles/<slug>.json (0600)
│   ├── command-context.ts # fail-closed workspace gate
│   ├── mutating.ts   # explicit write flag (POST lists are not writes)
│   ├── errors.ts     # Typed error classes
│   ├── output.ts     # JSON output formatting
│   └── handler.ts    # Request builder from CommandDefinition
├── commands/
│   ├── campaigns/    # 15 commands
│   ├── inbox/        # 4 commands
│   ├── accounts/     # 2 commands
│   ├── lists/        # 9 commands
│   ├── stats/        # 1 command
│   ├── leads/        # 4 commands
│   ├── lead-tags/    # 1 command
│   ├── webhooks/     # 5 commands
│   ├── network/      # 2 commands
│   └── org/          # 11 commands
├── mcp-entry.ts      # MCP server (auto-registers all commands)
└── index.ts          # CLI entry point

Adding a new API endpoint = creating one file. It's automatically available in both CLI and MCP.

HTTP Client Features

Auto-retry with exponential backoff on 429 (rate limit) and 5xx errors
Rate limit awareness — respects Retry-After headers
Offset/limit pagination — handles HeyReach's POST body pagination pattern
30-second timeout with configurable retries (default: 3)
Typed errors — AuthError, NotFoundError, RateLimitError, ValidationError, ServerError

Development

git clone https://github.com/bcharleson/heyreach-cli.git
cd heyreach-cli
bun install

bun run dev -- campaigns list    # Run in dev mode (tsx)
bun run build                    # Build with tsup
bun run typecheck                # Type-check (tsc --noEmit)
bun test                         # Run tests (vitest)

Tech Stack

TypeScript (ESM, strict mode)
Node.js 18+
Commander.js — CLI framework
Zod — schema validation (shared between CLI and MCP)
@modelcontextprotocol/sdk — MCP server
tsup — bundler
vitest — test runner

License

MIT

Name		Name	Last commit message	Last commit date
src		src
tests		tests
.gitignore		.gitignore
AGENTS.md		AGENTS.md
CHANGELOG.md		CHANGELOG.md
CLAUDE.md		CLAUDE.md
HEYREACH_API_AUDIT.md		HEYREACH_API_AUDIT.md
README.md		README.md
SKILL.md		SKILL.md
bun.lock		bun.lock
package.json		package.json
tsconfig.json		tsconfig.json
tsup.config.ts		tsup.config.ts

Latest commit

History

Folders and files

Repository files navigation