# List Jobs

> Retrieve a paginated list of background jobs in your workspace, newest first.

<Note>
  **Beta.** This endpoint is not in production yet and may change before it ships.
</Note>

Requires an API key with the `read` scope.

## Query Parameters

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

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

<ParamField query="type" type="string">
  Filter by job type, for example `lead_import` or `email_verification`.
</ParamField>

<ParamField query="status" type="string">
  Filter by status: `pending`, `running`, `completed` or `failed`.
</ParamField>

## Response

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

  <Expandable title="Job object">
    <ResponseField name="id" type="string">Job identifier.</ResponseField>
    <ResponseField name="type" type="string">Job type, for example `lead_import` or `email_verification`.</ResponseField>
    <ResponseField name="status" type="string">`pending`, `running`, `completed` or `failed`.</ResponseField>
    <ResponseField name="progress" type="integer">Percent complete, 0 to 100.</ResponseField>
    <ResponseField name="totalItems" type="integer">Number of items the job will process.</ResponseField>
    <ResponseField name="completedItems" type="integer">Number of items processed so far.</ResponseField>
    <ResponseField name="result" type="object">Result counters once the job has produced them, otherwise `null`. A lead import returns `imported`, `restored`, `failed` and, when it started a verification run, `verificationJobId`. A verification run returns `good`, `risky`, `bad`, `errors` and `billableCount`. Raw rows and failed-row details are never returned.</ResponseField>
    <ResponseField name="error" type="string">Error summary when the job failed, otherwise `null`.</ResponseField>
    <ResponseField name="startedAt" type="string">ISO 8601 timestamp, or `null`.</ResponseField>
    <ResponseField name="completedAt" type="string">ISO 8601 timestamp, or `null`.</ResponseField>
    <ResponseField name="createdAt" type="string">ISO 8601 timestamp.</ResponseField>
  </Expandable>
</ResponseField>

<RequestExample>
```bash cURL
curl -X GET "https://api.foxreach.io/api/v1/jobs?status=running" \
  -H "X-API-Key: otr_your_key"
```

```python Python SDK (beta)
from foxreach import FoxReach

client = FoxReach(api_key="otr_your_key")
jobs = client.jobs.list(status="running")
```

```typescript TypeScript SDK (beta)
import { FoxReach } from "foxreach";

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

<ResponseExample>
```json
{
  "data": [
    {
      "id": "cmjob123",
      "type": "lead_import",
      "status": "completed",
      "progress": 100,
      "totalItems": 250,
      "completedItems": 250,
      "result": { "imported": 240, "restored": 4, "failed": 6, "verificationJobId": "cmjob124" },
      "error": null,
      "startedAt": "2026-11-04T09:00:02",
      "completedAt": "2026-11-04T09:00:41",
      "createdAt": "2026-11-04T09:00:00"
    }
  ],
  "meta": {
    "page": 1,
    "pageSize": 25,
    "total": 1,
    "totalPages": 1
  }
}
```
</ResponseExample>

## Errors

| Status | Description |
|--------|-------------|
| `401` | Missing, invalid, revoked or expired API key |
| `403` | API key does not have the required scope: `read` |

## Rate Limit

- **600 requests per minute, shared by every `poll` call in your workspace.** Fixed 60-second window.
- Every response includes `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` (unix epoch seconds) and `X-RateLimit-Bucket` (`poll`).
- 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).