Refgrow

Refgrow CLI

Manage your Refgrow affiliate program from the command line. Wraps the public REST API v1 so shell scripts, cron jobs, and CI pipelines can do anything the dashboard does.

Install

bash
npm install -g @refgrow/cli

Or one-shot via npx, no install needed:

bash
npx @refgrow/cli affiliates list

Authenticate

bash
refgrow login

You will be prompted for an API key. Generate one at Settings → API Keys. The key is saved to ~/.refgrowrc with mode 600.

Alternatives, evaluated in this order:

  • --api-key <key> flag — one-shot use, handy in CI where you keep the key in a secret store.
  • REFGROW_API_KEY environment variable.
  • ~/.refgrowrc from refgrow login.

Verify the current setup:

bash
refgrow whoami

Commands

Affiliates

bash
refgrow affiliates list [--status active|inactive] [--limit 100] [--page 1] [--all]
refgrow affiliates get <email>
refgrow affiliates create <email> [--code XYZ] [--partner-slug s] \
  [--payment-method "USDT TRC-20"] [--payment-details "0xabc..."]
refgrow affiliates update <email> [--email new@x.com] [--code NEW] \
  [--status active|inactive] [--payout-method paypal|wise|manual] \
  [--paypal-email e] [--payment-method m] [--payment-details d]
refgrow affiliates delete <email> [--yes]

Referrals

bash
refgrow referrals list [--all]
refgrow referrals get <email>
refgrow referrals create <email> --affiliate-id 123 [--status active]
refgrow referrals update <email> [--email new@x.com] [--affiliate-id 456] [--status s]
refgrow referrals delete <email> [--yes]

Conversions

bash
refgrow conversions list [--type signup|purchase] [--all]
refgrow conversions get <id>
refgrow conversions create --email x@y.com --type purchase --value 100 \
  [--currency USD] [--affiliate-code CODE] [--reference ord_xyz]
refgrow conversions update <id> [--value 200] [--type signup|purchase] [--reference ref] \
  [--coupon-code CODE] [--paid] [--unpaid]
refgrow conversions delete <id> [--yes]

Coupons

bash
refgrow coupons list [--affiliate-id 123] [--coupon-code XYZ] [--all]
refgrow coupons get <id>
refgrow coupons create --affiliate-id 123 --code XYZ20
refgrow coupons update <id> [--code NEW] [--status active|inactive]
refgrow coupons delete <id> [--yes]

Output formats

By default, list commands print a pretty aligned table and get prints key-value pairs. Override the format with:

  • --json — raw JSON, pipe-friendly with jq.
  • --csv — CSV with header row.
  • --quiet — drop headers and decorations, useful in shell loops.
  • --no-color — disable ANSI colors. Auto-disabled when stdout is not a TTY.

Examples

Export every affiliate to a CSV file:

bash
refgrow affiliates list --all --csv > affiliates.csv

Bulk-mark a list of conversion ids as paid:

bash
cat conversion-ids.txt | while read id; do
  refgrow conversions update "$id" --paid
done

Record a manual conversion from a Stripe charge inside a webhook handler:

bash
refgrow conversions create \
  --email "$EMAIL" \
  --type purchase \
  --value "$AMOUNT" \
  --currency USD \
  --reference "$STRIPE_CHARGE_ID"

Pipe into jq to find a referral's source affiliate:

bash
refgrow referrals get user@example.com --json | jq '.affiliate_email'

Exit codes

  • 0 — success
  • 1 — user error (no API key configured, invalid flag)
  • 2 — API error (4xx / 5xx response or network failure)

Which surface should I use?

SurfaceBest for
CLI (this page)Shell scripts, cron jobs, CI, ad-hoc queries
MCP serverAI assistants (Claude Desktop, Cursor, etc.)
REST APICustom backend integrations
Zapier / Make / n8nNo-code automation flows

Support

Bug reports and feature requests: support@refgrow.com, or the chat widget in the bottom-right corner of any page on refgrow.com.

Start Free Trial
Refgrow CLI — Refgrow Docs