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 list --email jane@example.com   # exact, case-insensitive match
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              # does not mark the thread read
foxreach inbox get rpl_abc123 --mark-read  # marks it read
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

Metadata

Release files for foxreach-cli 0.6.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.6.0
File Size Uploaded Provenance Actions
foxreach_cli-0.6.0.tar.gz 48.9 kB With provenance Details for foxreach_cli-0.6.0.tar.gz

Built distribution (wheel)

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

Total release size: 98.2 kB

Release files / foxreach_cli-0.6.0.tar.gz

Download URL foxreach_cli-0.6.0.tar.gz
Size 48.9 kB
Tags Source
SHA-256 checksum
How to use checksums
16ddb9027bc51107e3390eef469de7ce1bf77e5c5813777a7a5b884626390428
BLAKE2b-256 checksum
How to use checksums
56820794bc8b0fdb93b0bceaad01da17ab2015bfd7048aeb24d3ebe68f9c723c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 4, 2026.

Transparency log

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

Download URL foxreach_cli-0.6.0-py3-none-any.whl
Size 49.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
1d99ce24013968ea2b0238a51781f5160f3b698a55a6320b5c26d3a018fbd48b
BLAKE2b-256 checksum
How to use checksums
76653fd7664d902e58632f16de4d8c3a05b874923d0483fb11e97c86393b13ae
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 4, 2026.

Transparency log

Security for foxreach-cli 0.6.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for foxreach_cli-0.6.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 4, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

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