Skip to main content

FoxReach CLI

Command-line interface for the FoxReach cold email outreach API.

Installation

pip install foxreach-cli

Setup

# Save your API key
foxreach config set-key
# Enter: otr_your_api_key

# Verify
foxreach config show

You can also use environment variables:

export FOXREACH_API_KEY=otr_your_api_key
export FOXREACH_BASE_URL=https://api.foxreach.io/api/v1  # optional

Usage

Leads

foxreach leads list
foxreach leads list --search "jane" --status active
foxreach leads get cld_abc123
foxreach leads create --email jane@example.com --first-name Jane --company "Acme"
foxreach leads update cld_abc123 --company "New Corp"
foxreach leads delete cld_abc123

Campaigns

foxreach campaigns list
foxreach campaigns list --status active
foxreach campaigns get cmp_xyz789
foxreach campaigns create --name "Q1 Outreach" --daily-limit 100
foxreach campaigns update cmp_xyz789 --daily-limit 200
foxreach campaigns start cmp_xyz789
foxreach campaigns pause cmp_xyz789
foxreach campaigns add-leads cmp_xyz789 --lead-ids cld_1,cld_2,cld_3
foxreach campaigns add-accounts cmp_xyz789 --account-ids acc_1
foxreach campaigns delete cmp_xyz789

Sequences

foxreach sequences list --campaign cmp_xyz789
foxreach sequences create --campaign cmp_xyz789 --subject "Hi {{firstName}}" --body "Hello!"
foxreach sequences update --campaign cmp_xyz789 --sequence seq_1 --delay-days 3
foxreach sequences delete --campaign cmp_xyz789 --sequence seq_1

Templates

foxreach templates list
foxreach templates get tpl_abc123
foxreach templates create --name "Follow-up" --body "Hi {{firstName}}, just checking in."
foxreach templates update tpl_abc123 --name "New Follow-up"
foxreach templates delete tpl_abc123

Email Accounts

foxreach accounts list
foxreach accounts get acc_abc123
foxreach accounts delete acc_abc123

Inbox

foxreach inbox list
foxreach inbox list --unread --category interested
foxreach inbox get rpl_abc123
foxreach inbox update rpl_abc123 --read --category qualified

Analytics

foxreach analytics overview
foxreach analytics campaign cmp_xyz789

JSON Output

Add --json to any command to get raw JSON output for scripting:

foxreach leads list --json | jq '.data[].email'
foxreach campaigns get cmp_xyz789 --json

Configuration

Config is stored at ~/.foxreach/config.json. Environment variables take precedence:

Setting Env Var Config Key
API Key FOXREACH_API_KEY api_key
Base URL FOXREACH_BASE_URL base_url

Release files for foxreach-cli 0.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for foxreach-cli 0.2.0
File Size Uploaded
foxreach_cli-0.2.0.tar.gz 10.6 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for foxreach-cli 0.2.0
File Interpreter ABI Platform
foxreach_cli-0.2.0-py3-none-any.whl Python 3 none any Details

Total release size: 28.2 kB

Release files / foxreach_cli-0.2.0.tar.gz

Download URL foxreach_cli-0.2.0.tar.gz
Size 10.6 kB
Tags Source
SHA-256 checksum
How to use checksums
00c646b2c9db8a277cc670d8ce8131a8a5f9ca116429e23c908c3fb378a03bb8
BLAKE2b-256 checksum
How to use checksums
7963868ed08d30abf2327fcdfaafd4dd2ba5e2787cf0136079eb650028413e89
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.13.2

Release files / foxreach_cli-0.2.0-py3-none-any.whl

Download URL foxreach_cli-0.2.0-py3-none-any.whl
Size 17.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
45978281727b66fc759e78eceba67907ff72496187d366e424b24729981aec79
BLAKE2b-256 checksum
How to use checksums
223ad01cce30238f7fce388de664d6c3a7e98a0b81c1f66f089b78c74812d587
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.13.2

Release history Release notifications | RSS feed

This release

0.2.0 This release

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page