> ## Documentation Index
> Fetch the complete documentation index at: https://docs.foxreach.io/llms.txt
> Use this file to discover all available pages before exploring further.

# List Campaigns

> Retrieve a paginated list of campaigns in your workspace.

## Query Parameters

<ParamField query="page" type="integer" default="1">
  Page number (starts at 1).
</ParamField>

<ParamField query="pageSize" type="integer" default="20">
  Number of campaigns per page (1-100).
</ParamField>

<ParamField query="status" type="string">
  Filter by status: `draft`, `active`, `paused`, or `completed`.
</ParamField>

## Response

<ResponseField name="data" type="array">
  Array of campaign objects.

  <Expandable title="Campaign object">
    <ResponseField name="id" type="string">Unique campaign identifier.</ResponseField>
    <ResponseField name="name" type="string">Campaign name.</ResponseField>
    <ResponseField name="status" type="string">Campaign status: `draft`, `active`, `paused`, `completed`.</ResponseField>
    <ResponseField name="timezone" type="string">Sending timezone (e.g., `UTC`, `America/New_York`).</ResponseField>
    <ResponseField name="sendingDays" type="array">Days of the week to send (1=Mon, 7=Sun).</ResponseField>
    <ResponseField name="sendingStartHour" type="integer">Start hour for sending (0-23).</ResponseField>
    <ResponseField name="sendingEndHour" type="integer">End hour for sending (0-23).</ResponseField>
    <ResponseField name="dailyLimit" type="integer">Maximum emails per day.</ResponseField>
    <ResponseField name="sentToday" type="integer">Emails sent today.</ResponseField>
    <ResponseField name="context" type="string">AI context for draft replies.</ResponseField>
    <ResponseField name="totalLeads" type="integer">Total leads enrolled.</ResponseField>
    <ResponseField name="totalSent" type="integer">Total emails sent.</ResponseField>
    <ResponseField name="totalDelivered" type="integer">Total emails delivered.</ResponseField>
    <ResponseField name="totalBounced" type="integer">Total bounced emails.</ResponseField>
    <ResponseField name="totalReplied" type="integer">Total replies received.</ResponseField>
    <ResponseField name="totalOpened" type="integer">Total email opens.</ResponseField>
    <ResponseField name="createdAt" type="string">ISO 8601 timestamp.</ResponseField>
    <ResponseField name="updatedAt" type="string">ISO 8601 timestamp.</ResponseField>
    <ResponseField name="startedAt" type="string">When the campaign was first started.</ResponseField>
    <ResponseField name="completedAt" type="string">When the campaign completed.</ResponseField>
  </Expandable>
</ResponseField>

<RequestExample>
  ```bash cURL theme={null}
  curl -X GET "https://api.foxreach.io/api/v1/campaigns?status=active" \
    -H "X-API-Key: otr_your_key"
  ```

  ```python Python SDK theme={null}
  from foxreach import FoxReach

  client = FoxReach(api_key="otr_your_key")
  campaigns = client.campaigns.list(status="active")
  ```

  ```typescript TypeScript SDK theme={null}
  import { FoxReach } from "foxreach";

  const client = new FoxReach({ apiKey: "otr_your_key" });
  const campaigns = await client.campaigns.list({ status: "active" });
  ```
</RequestExample>

<ResponseExample>
  ```json theme={null}
  {
    "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
    }
  }
  ```
</ResponseExample>

## 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](/rate-limiting).
