Articles on: Integrations & API

Use SalesBlink CLI

title: Use SalesBlink CLI
description: Manage SalesBlink from your terminal with the official @salesblink/cli npm package.

Overview

The SalesBlink CLI is the official command-line interface for the SalesBlink cold email outreach platform. It wraps the SalesBlink Public API so you can manage lists, sequences, senders, inbox, and analytics directly from your terminal, scripts, or CI/CD pipelines.

npm package: https://www.npmjs.com/package/@salesblink/cli
GitHub repository: https://github.com/open-salesblink/cli

Prerequisites

Before you start, confirm you have the following:

Active SalesBlink account: Sign up at https://run.salesblink.io/signup if you do not have one.
SalesBlink API key: Retrieve it from SalesBlink Dashboard > Integrations > API.
Node.js 20 or later: Required for the npm install.

Installation

Install the CLI globally from npm:

npm install -g @salesblink/cli

Alternatively, run it without installing using npx:

npx @salesblink/cli sequences list

Step-by-Step Instructions

Step 1: Get Your API Key

Log in to your SalesBlink account.
Click Account in the Top Navbar.
Select Integrations from the dropdown.
Click the API tab.
Click Create API Key.
Enter a name for your API key (e.g., "SalesBlink CLI").
Click Create New API Key.
Copy the generated API key.

Step 2: Configure the CLI

Save your API key in the CLI config file:

salesblink config set api_key sb-xxxxxxxxxxxxxxxx

Note: Replace sb-xxxxxxxxxxxxxxxx with the actual key you copied in Step 1. The key is stored in ~/.salesblink/config.json with restricted permissions, so you only need to do this once.

Step 3: Verify the Connection

Test that the CLI can reach your SalesBlink account:

salesblink sequences list

You should see a table of your sequences (campaigns).

Common Commands

Task	Command
List lists	`salesblink lists list`
Create a list	`salesblink lists create --name "SaaS Founders"`
Export list leads as CSV	`salesblink lists leads --id <list-id> --format csv > leads.csv`
List sequences	`salesblink sequences list`
Get sequence stats	`salesblink sequences stats --id <sequence-id>`
Pause a sequence	`salesblink sequences status --id <sequence-id> --status PAUSED`
Resume a sequence	`salesblink sequences status --id <sequence-id> --status ACTIVE`
Check sender health	`salesblink senders health --id <sender-id>`
View inbox	`salesblink inbox list`
View overall analytics	`salesblink analytics overall`

Output Formats

The CLI prints a table in interactive terminals and JSON when piped. Override with --format:

salesblink sequences list --format json | jq '.data[].name'
salesblink sequences list --format csv > sequences.csv

All data goes to stdout, and all errors and warnings go to stderr, so the CLI works cleanly in scripts and cron jobs.

Rate Limits

The SalesBlink API uses tiered rate limiting: 30 GET requests/minute, 15 POST/PATCH requests/minute, and 10 PUT/DELETE requests/minute. Pass --retry to automatically back off and retry on HTTP 429:

salesblink --retry sequences list

Troubleshooting

Command Not Found

Confirm the install succeeded with npm list -g @salesblink/cli.
Make sure your global npm bin directory is on your PATH (npm bin -g).

Authentication Errors

The CLI exits with code 2 when the API key is missing or invalid.
Re-run salesblink config set api_key <your-key> and verify the key is active in SalesBlink Dashboard > Integrations > API.

Rate Limit Errors

Wait 60 seconds and retry, or re-run the command with --retry.

Get Help

If you are stuck:

Run salesblink --help or salesblink <command> --help for the full command reference.
Visit the npm package page: https://www.npmjs.com/package/@salesblink/cli
Contact SalesBlink support at https://salesblink.io/contact-us.
Read the full API documentation at https://developer.salesblink.io.

Updated on: 18/08/2026

Was this article helpful?

Thank you!