curl -X GET "https://api.foxreach.io/api/v1/leads?page=1&pageSize=20&search=acme" \
-H "X-API-Key: otr_your_key"
from foxreach import FoxReach
client = FoxReach(api_key="otr_your_key")
leads = client.leads.list(page=1, page_size=20, search="acme")
import { FoxReach } from "foxreach";
const client = new FoxReach({ apiKey: "otr_your_key" });
const leads = await client.leads.list({ page: 1, pageSize: 20, search: "acme" });
{
"data": [
{
"id": "cld_abc123",
"email": "[email protected]",
"firstName": "John",
"lastName": "Doe",
"company": "Acme Inc",
"title": "VP of Sales",
"phone": "+1-555-0100",
"linkedinUrl": "https://linkedin.com/in/johndoe",
"website": "https://acme.com",
"customFields": { "industry": "SaaS" },
"notes": null,
"source": "csv_import",
"status": "active",
"lastContactedAt": null,
"createdAt": "2025-01-15T10:30:00",
"updatedAt": "2025-01-15T10:30:00"
}
],
"meta": {
"page": 1,
"pageSize": 20,
"total": 1,
"totalPages": 1
}
}
Leads
List Leads
Retrieve a paginated list of leads in your workspace.
GET
/
api
/
v1
/
leads
curl -X GET "https://api.foxreach.io/api/v1/leads?page=1&pageSize=20&search=acme" \
-H "X-API-Key: otr_your_key"
from foxreach import FoxReach
client = FoxReach(api_key="otr_your_key")
leads = client.leads.list(page=1, page_size=20, search="acme")
import { FoxReach } from "foxreach";
const client = new FoxReach({ apiKey: "otr_your_key" });
const leads = await client.leads.list({ page: 1, pageSize: 20, search: "acme" });
{
"data": [
{
"id": "cld_abc123",
"email": "[email protected]",
"firstName": "John",
"lastName": "Doe",
"company": "Acme Inc",
"title": "VP of Sales",
"phone": "+1-555-0100",
"linkedinUrl": "https://linkedin.com/in/johndoe",
"website": "https://acme.com",
"customFields": { "industry": "SaaS" },
"notes": null,
"source": "csv_import",
"status": "active",
"lastContactedAt": null,
"createdAt": "2025-01-15T10:30:00",
"updatedAt": "2025-01-15T10:30:00"
}
],
"meta": {
"page": 1,
"pageSize": 20,
"total": 1,
"totalPages": 1
}
}
Query Parameters
integer
default:"1"
Page number (starts at 1).
integer
default:"50"
Number of leads per page (1-100).
string
Search across email, first name, last name, and company.
string
Filter by lead status:
active, bounced, unsubscribed, or replied.Response
array
Array of lead objects.
Show Lead object
Show Lead object
string
Unique lead identifier.
string
Lead’s email address.
string
First name.
string
Last name.
string
Company name.
string
Job title.
string
Phone number.
string
LinkedIn profile URL.
string
Website URL.
object
Custom key-value fields.
string
Freeform notes.
string
How the lead was created (e.g.,
api, csv_import, manual).string
Lead status.
string
ISO 8601 timestamp.
string
ISO 8601 timestamp.
object
curl -X GET "https://api.foxreach.io/api/v1/leads?page=1&pageSize=20&search=acme" \
-H "X-API-Key: otr_your_key"
from foxreach import FoxReach
client = FoxReach(api_key="otr_your_key")
leads = client.leads.list(page=1, page_size=20, search="acme")
import { FoxReach } from "foxreach";
const client = new FoxReach({ apiKey: "otr_your_key" });
const leads = await client.leads.list({ page: 1, pageSize: 20, search: "acme" });
{
"data": [
{
"id": "cld_abc123",
"email": "[email protected]",
"firstName": "John",
"lastName": "Doe",
"company": "Acme Inc",
"title": "VP of Sales",
"phone": "+1-555-0100",
"linkedinUrl": "https://linkedin.com/in/johndoe",
"website": "https://acme.com",
"customFields": { "industry": "SaaS" },
"notes": null,
"source": "csv_import",
"status": "active",
"lastContactedAt": null,
"createdAt": "2025-01-15T10:30:00",
"updatedAt": "2025-01-15T10:30:00"
}
],
"meta": {
"page": 1,
"pageSize": 20,
"total": 1,
"totalPages": 1
}
}
Rate Limit
- 100 requests per minute, per API key. Fixed 60-second window.
- Every response includes
X-RateLimit-Limit,X-RateLimit-Remaining, andX-RateLimit-Reset(unix epoch seconds). - A
429response includes aRetry-Afterheader (seconds until the bucket resets).
Retry-After, exponential backoff, monitoring X-RateLimit-Remaining), see Rate Limiting.