CLI for the FoxReach cold email outreach API
Project description
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 |
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file foxreach_cli-0.1.0.tar.gz.
File metadata
- Download URL: foxreach_cli-0.1.0.tar.gz
- Upload date:
- Size: 9.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0cc55b160dd312bbf905dada1d374627f656ac42cf9695bbee4a6d4ea0786b63
|
|
| MD5 |
c663a4ecd03ddff5d34f318d9d4e47ee
|
|
| BLAKE2b-256 |
f1c4d8b9849398ea91fedcee6269fa77d5a22c257635ae4de725c390b1701aa8
|
Provenance
The following attestation bundles were made for foxreach_cli-0.1.0.tar.gz:
Publisher:
publish.yml on foxreach/foxreach-cli
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
foxreach_cli-0.1.0.tar.gz -
Subject digest:
0cc55b160dd312bbf905dada1d374627f656ac42cf9695bbee4a6d4ea0786b63 - Sigstore transparency entry: 960009723
- Sigstore integration time:
-
Permalink:
foxreach/foxreach-cli@db0fe22b1c5a4179a4551dbc132aa997cbe530f4 -
Branch / Tag:
refs/tags/v0.1.0 - Owner: https://github.com/foxreach
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@db0fe22b1c5a4179a4551dbc132aa997cbe530f4 -
Trigger Event:
release
-
Statement type:
File details
Details for the file foxreach_cli-0.1.0-py3-none-any.whl.
File metadata
- Download URL: foxreach_cli-0.1.0-py3-none-any.whl
- Upload date:
- Size: 15.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
98e593899766b1fc8c0f0cfe9092abf8381055b7c2acc9433e4da359532904b2
|
|
| MD5 |
a7e9de585a9a84a30cfd69af1e38e5a1
|
|
| BLAKE2b-256 |
fe3551896205ac2f920b686337122f73289c4cf4846c0a4f8cfb2e48593de199
|
Provenance
The following attestation bundles were made for foxreach_cli-0.1.0-py3-none-any.whl:
Publisher:
publish.yml on foxreach/foxreach-cli
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
foxreach_cli-0.1.0-py3-none-any.whl -
Subject digest:
98e593899766b1fc8c0f0cfe9092abf8381055b7c2acc9433e4da359532904b2 - Sigstore transparency entry: 960009766
- Sigstore integration time:
-
Permalink:
foxreach/foxreach-cli@db0fe22b1c5a4179a4551dbc132aa997cbe530f4 -
Branch / Tag:
refs/tags/v0.1.0 - Owner: https://github.com/foxreach
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@db0fe22b1c5a4179a4551dbc132aa997cbe530f4 -
Trigger Event:
release
-
Statement type: