Introduction

Welcome to the FoxReach API

The FoxReach API lets you integrate your cold email outreach platform with your existing tools, CRMs, and automation workflows. Build powerful integrations to manage your leads, campaigns, and email infrastructure programmatically.

What you can do

Manage Leads

Create, update, and organize your leads. Import contacts from your CRM or sync them in real-time.

Control Campaigns

Create multi-step email campaigns, start and pause them, and monitor performance.

Email Accounts

View your connected email accounts, warmup settings, and health metrics.

Templates & Variables

Build reusable email templates with personalization variables and spin syntax for deliverability.

MCP Server

Connect AI agents like Claude and Cursor to FoxReach. Manage leads and campaigns through natural language.

Webhooks

Receive real-time notifications when emails are sent, replies come in, or campaigns complete.

Error Handling

Understand error codes and build resilient integrations with proper error handling.

Quick Start

Prerequisites

A FoxReach account with an active workspace
An API key (create one in Settings > API Keys)

Make your first request

Get your API key

Go to Settings > API Keys in the dashboard and create a new key. Copy it — you’ll only see it once.

List your leads

curl -X GET https://api.foxreach.io/api/v1/leads \
  -H "X-API-Key: otr_your_api_key_here"

import requests

response = requests.get(
    "https://api.foxreach.io/api/v1/leads",
    headers={"X-API-Key": "otr_your_api_key_here"}
)
leads = response.json()

const response = await fetch(
  "https://api.foxreach.io/api/v1/leads",
  { headers: { "X-API-Key": "otr_your_api_key_here" } }
);
const leads = await response.json();

Check the response

{
  "data": [
    {
      "id": "cld_abc123",
      "email": "john@example.com",
      "firstName": "John",
      "lastName": "Doe",
      "company": "Acme Inc",
      "status": "active",
      "createdAt": "2025-01-15T10:30:00"
    }
  ],
  "meta": {
    "page": 1,
    "pageSize": 50,
    "total": 1,
    "totalPages": 1
  }
}

Base URL

All API requests are made to:

https://api.foxreach.io/api/v1

Authentication

Include your API key in the X-API-Key header with every request. See Authentication for details.

-H "X-API-Key: otr_your_api_key_here"

Response Format

All responses use a consistent envelope format. Single resource:

{
  "data": { ... }
}

List of resources:

{
  "data": [ ... ],
  "meta": {
    "page": 1,
    "pageSize": 50,
    "total": 100,
    "totalPages": 2
  }
}

Error:

{
  "detail": "Lead not found"
}

See Errors for a full reference of error codes and formats.

HTTP Status Codes

Code	Description
`200`	Request succeeded
`201`	Resource created successfully
`204`	Resource deleted successfully
`400`	Bad request — check your request body
`403`	Invalid or missing API key
`404`	Resource not found
`409`	Conflict — resource already exists
`422`	Validation error — check field values
`429`	Rate limit exceeded — slow down
`500`	Server error — retry with backoff

Need Help?

If you run into issues or have questions, reach out to our support team from the dashboard.

Getting started

API guides

Leads

Campaigns

Sequences

Campaign Leads

Campaign Accounts

Inbox

Email Accounts

Templates

Analytics

Webhooks API

Welcome to the FoxReach API

What you can do

Manage Leads

Control Campaigns

Email Accounts

Templates & Variables

MCP Server

Webhooks

Error Handling

Quick Start

Prerequisites

Make your first request

Base URL

Authentication

Response Format

HTTP Status Codes

Need Help?

​Welcome to the FoxReach API

​What you can do

Manage Leads

Control Campaigns

Email Accounts

Templates & Variables

MCP Server

Webhooks

Error Handling

​Quick Start

​Prerequisites

​Make your first request

​Base URL

​Authentication

​Response Format

​HTTP Status Codes

​Need Help?

Welcome to the FoxReach API

What you can do

Quick Start

Prerequisites

Make your first request

Base URL

Authentication

Response Format

HTTP Status Codes

Need Help?