Skip to main content
GET
/
api
/
v1
/
campaigns
curl -X GET "https://api.foxreach.io/api/v1/campaigns?status=active" \
  -H "X-API-Key: otr_your_key"

{
  "data": [
    {
      "id": "cmp_abc123",
      "name": "Q1 Outreach",
      "status": "active",
      "timezone": "America/New_York",
      "sendingDays": [1, 2, 3, 4, 5],
      "sendingStartHour": 9,
      "sendingEndHour": 17,
      "dailyLimit": 50,
      "sentToday": 12,
      "context": null,
      "totalLeads": 500,
      "totalSent": 234,
      "totalDelivered": 230,
      "totalBounced": 4,
      "totalReplied": 18,
      "totalOpened": 87,
      "createdAt": "2025-01-10T08:00:00",
      "updatedAt": "2025-01-15T10:30:00",
      "startedAt": "2025-01-10T09:00:00",
      "completedAt": null
    }
  ],
  "meta": {
    "page": 1,
    "pageSize": 20,
    "total": 1,
    "totalPages": 1
  }
}

​
Query Parameters

​
page
integer
default:"1"
Page number (starts at 1).
​
pageSize
integer
default:"20"
Number of campaigns per page (1-100).
​
status
string
Filter by status: draft, active, paused, or completed.

​
Response

​
data
array
Array of campaign objects.
curl -X GET "https://api.foxreach.io/api/v1/campaigns?status=active" \
  -H "X-API-Key: otr_your_key"

{
  "data": [
    {
      "id": "cmp_abc123",
      "name": "Q1 Outreach",
      "status": "active",
      "timezone": "America/New_York",
      "sendingDays": [1, 2, 3, 4, 5],
      "sendingStartHour": 9,
      "sendingEndHour": 17,
      "dailyLimit": 50,
      "sentToday": 12,
      "context": null,
      "totalLeads": 500,
      "totalSent": 234,
      "totalDelivered": 230,
      "totalBounced": 4,
      "totalReplied": 18,
      "totalOpened": 87,
      "createdAt": "2025-01-10T08:00:00",
      "updatedAt": "2025-01-15T10:30:00",
      "startedAt": "2025-01-10T09:00:00",
      "completedAt": null
    }
  ],
  "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, and X-RateLimit-Reset (unix epoch seconds).
  • A 429 response includes a Retry-After header (seconds until the bucket resets).
For client-side patterns (Retry-After, exponential backoff, monitoring X-RateLimit-Remaining), see Rate Limiting.