Max CLI Skill

Max is a lead intelligence platform that monitors sources (LinkedIn, funding databases, etc.) and discovers new leads for sales teams. This CLI lets you manage businesses, signals, subscriptions, leads, and webhooks from the terminal.

Setup

npm install -g sortlist-max-cli
max login

max login connects via your browser using the OAuth 2.0 device authorization flow (RFC 8628): it prints an XXXX-XXXX verification code, opens the Max device page, and once you click Connect the CLI is authenticated automatically. Tokens are saved to ~/.max/config.json (mode 0600) and refreshed automatically. Run max logout to disconnect.

For CI or other non-interactive environments, skip max login and set an API key instead (from Settings > API Keys), which always takes precedence:

export MAX_API_KEY=your_api_key

Concepts

• Team: Your organization. API keys are scoped to a team.
• Business: A company you're prospecting for. Each team can have multiple businesses. Leads, subscriptions, and webhooks are scoped to a business.
• Signal: A type of monitoring (e.g. "LinkedIn Company Engagers", "Recently Funded Companies"). Read-only catalog.
• Subscription: An active signal you've configured (e.g. "Track engagers on Apple's LinkedIn page"). You create, pause, resume, and delete these.
• Lead: An enriched profile discovered by a subscription. Contains name, email, company, LinkedIn URL, and more.
• Webhook: A URL that receives an HTTP POST whenever a new lead is discovered.
• Integration: A connected external tool (e.g. Overloop, Instantly, Slack, Webhook) that can receive leads. Integrations are configured at the business level, then linked to individual subscriptions for automatic or manual delivery.
• Campaign-based integration: Integrations like Overloop and Instantly that organize outreach into campaigns. They expose campaigns via integrations:campaigns and support enrolling leads into a specific campaign.
• Subscription Integration: The link between a subscription and an integration, with settings like auto_deliver and a campaign_id (for campaign-based integrations).

All Commands

All output is JSON. Pipe to jq for filtering. Commands that operate on leads, subscriptions, or webhooks require --business (-b) to specify the business ID.

Businesses

# List all businesses in the team
max businesses:list

# Get a business with its Ideal Customer Profile
max businesses:get <id>
max businesses:get 1

# Create a business from a website (auto-analyzes name, description, ICP)
max businesses:create --website <url>
max businesses:create --website https://acme.com

# Create a business manually
max businesses:create --name <name> [--website <url>] [--description <text>] [--icp '<json>']
max businesses:create --name "Acme Corp" --website https://acme.com

# Update a business or its ICP
max businesses:update <id> [--name <name>] [--website <url>] [--description <text>] [--icp '<json>']
max businesses:update 1 --icp '{"id":1,"target_job_titles":["CTO"]}'

Signals (read-only catalog)

# List all available signal types
max signals:list

# Get details for a signal type
max signals:get <slug>
max signals:get linkedin-company-engagers

Subscriptions (your active signals)

# List all subscriptions for a business
max subscriptions:list --business <id>
max subscriptions:list --business 1

# Get a subscription with stats
max subscriptions:get <id> --business <business_id>
max subscriptions:get 42 --business 1

# Create a subscription
max subscriptions:create --business <id> --signal <slug> --name <name> [--config '<json>'] [--integrations '<json>']
max subscriptions:create --business 1 --signal linkedin-company-engagers --name "Apple Engagers" --config '{"linkedin_url":"https://www.linkedin.com/company/apple/"}'

# Create a subscription with a campaign integration linked (Overloop or Instantly)
max subscriptions:create --business 1 --signal linkedin-company-engagers --name "Apple Engagers" \
  --config '{"linkedin_url":"https://www.linkedin.com/company/apple/"}' \
  --integrations '[{"integration_id":5,"auto_deliver":true,"campaign_id":"abc123","campaign_name":"Q1 Outreach"}]'

# Update a subscription
max subscriptions:update <id> --business <business_id> [--name <name>] [--active <bool>] [--config '<json>'] [--integrations '<json>']
max subscriptions:update 42 --business 1 --name "New Name"

# Link or update integrations on an existing subscription
max subscriptions:update 42 --business 1 \
  --integrations '[{"integration_id":5,"auto_deliver":true,"campaign_id":"abc123","campaign_name":"Q1 Outreach"}]'

# Pause a subscription (stops scanning for new leads)
max subscriptions:pause <id> --business <business_id>
max subscriptions:pause 42 --business 1

# Resume a paused subscription
max subscriptions:resume <id> --business <business_id>
max subscriptions:resume 42 --business 1

# Delete a subscription
max subscriptions:delete <id> --business <business_id>
max subscriptions:delete 42 --business 1

Integrations (connected tools like Overloop and Instantly)

# List all integrations for a business
max integrations:list --business <id>
max integrations:list --business 1

# List campaigns available in a campaign-based integration (Overloop or Instantly)
max integrations:campaigns <integration_id> --business <business_id>
max integrations:campaigns 5 --business 1

The --integrations option on subscriptions:create and subscriptions:update accepts a JSON array. Each entry has:

• integration_id (required): The integration to link.
• auto_deliver (optional, default false): If true, new leads are automatically sent to this integration.
• campaign_id (optional): The campaign ID to enroll leads into (for campaign-based integrations like Overloop and Instantly). Legacy alias: overloop_campaign_id.
• campaign_name (optional): Display name for the campaign. Legacy alias: overloop_campaign_name.

Passing --integrations replaces all current integration links on the subscription. Omit an integration from the array to unlink it.

Leads (discovered profiles)

Each lead includes: id, external_id, name, headline, job_title, email, phone, linkedin_url, profile_picture, location, company, company_logo, company_industry, company_size, company_website, company_linkedin, company_founded, connections, followers, icp_score, engagement_type, post_url, signals, subscription_ids, payload, triggered_at, created_at. Fields are null when not available.

# List leads (paginated)
max leads:list --business <id> [--page <n>] [--per-page <n>]
max leads:list --business 1 --page 2 --per-page 50

# Get a single lead with delivery history
max leads:get <id> --business <business_id>
max leads:get 1234 --business 1

# Delete a lead (soft-delete)
max leads:delete <id> --business <business_id>
max leads:delete 1234 --business 1

# Enroll leads into a campaign (Overloop or Instantly)
max leads:enroll --business <id> --integration <integration_id> --campaign <campaign_id> --leads <comma_separated_ids>
max leads:enroll --business 1 --integration 5 --campaign abc123 --leads 100,101,102

Webhooks

# List registered webhooks for a business
max webhooks:list --business <id>
max webhooks:list --business 1

# Create a webhook (with optional HMAC signing secret)
max webhooks:create --business <id> --url <url> [--secret <secret>]
max webhooks:create --business 1 --url https://example.com/webhook --secret my_secret

# Delete a webhook
max webhooks:delete <id> --business <business_id>
max webhooks:delete 10 --business 1

Common Workflows

Set up a new business and start monitoring

# 1. Create a business from a website (auto-generates ICP)
max businesses:create --website https://acme.com

# 2. Note the business ID from the response, then browse signals
max signals:list

# 3. Get details on a signal
max signals:get linkedin-company-engagers

# 4. Create a subscription
max subscriptions:create --business 1 \
  --signal linkedin-company-engagers \
  --name "Acme Engagers" \
  --config '{"linkedin_url":"https://www.linkedin.com/company/acme/"}'

Check leads and export

# List recent leads
max leads:list --business 1 --per-page 100

# Get full details for a specific lead (includes email, phone, deliveries)
max leads:get 1234 --business 1

# Get all leads as JSON for processing
max leads:list --business 1 --per-page 100 | jq '.leads[] | {name, email: .payload.email, company}'

Set up a webhook for real-time notifications

# Register a webhook
max webhooks:create --business 1 --url https://my-app.com/signals-webhook --secret whsec_abc123

# Verify it was created
max webhooks:list --business 1

# Remove it later
max webhooks:delete 10 --business 1

Connect a campaign integration (Overloop or Instantly) to a subscription

# 1. List integrations to find the campaign integration ID
max integrations:list --business 1

# 2. List available campaigns for that integration
max integrations:campaigns 5 --business 1

# 3. Link the integration to a subscription with auto-delivery
max subscriptions:update 42 --business 1 \
  --integrations '[{"integration_id":5,"auto_deliver":true,"campaign_id":"abc123","campaign_name":"Q1 Outreach"}]'

Manually enroll leads into a campaign (Overloop or Instantly)

# 1. Find leads to enroll
max leads:list --business 1 --per-page 50

# 2. Enroll specific leads by ID
max leads:enroll --business 1 --integration 5 --campaign abc123 --leads 100,101,102
# Returns: {"enqueued": 3, "skipped": 0}
# Leads without an email or LinkedIn URL are skipped.

Pause and resume a subscription

# Pause (stops scanning)
max subscriptions:pause 42 --business 1

# Resume (starts scanning again)
max subscriptions:resume 42 --business 1

Error Handling

• Exit code 0: Success. Output is JSON on stdout.
• Exit code 1: Error. Message is printed to stderr.
• 401: Not authenticated (run max login) or an invalid/expired credential. OAuth sessions are refreshed automatically; if refresh fails, log in again.
• 404: Resource not found.
• 422: Validation error (e.g. missing required fields).
• 429: Rate limited (60 requests/minute per key).

Environment Variables

Variable	Required	Description
MAX_API_KEY	No	Your Max API key. Takes precedence over the OAuth session saved by max login.
MAX_API_URL	No	Override the API base URL (default https://api.yourmax.ai).
MAX_OAUTH_URL	No	Override the OAuth/authorization server URL used by max login (default https://yourmax.ai).
MAX_CLI_CLIENT_ID	No	Override the public OAuth client_id (default max-cli).