# Add List to Leads

> Add the revealed people of a list to Leads.

Requires an API key with the `write` scope.

Free. Adds the people in the list whose email was found. Counts toward the contact limit, all or nothing. Only a people list can be added.

## Path Parameters

<ParamField path="list_id" type="string" required>The list id.</ParamField>

## Body Parameters

<ParamField body="keys" type="array">Item keys to add. Omit for every person in the list.</ParamField>
<ParamField body="campaignId" type="string">Also place them in this campaign.</ParamField>

## Response

<ResponseField name="data" type="object">
  <Expandable title="data">
    <ResponseField name="added" type="integer">New leads created.</ResponseField>
    <ResponseField name="restored" type="integer">Deleted leads brought back.</ResponseField>
    <ResponseField name="alreadyInLeads" type="integer">People who were already active leads.</ResponseField>
    <ResponseField name="blocked" type="integer">People skipped because they are on the block list.</ResponseField>
    <ResponseField name="skipped" type="integer">Items with no found email.</ResponseField>
    <ResponseField name="addedToCampaign" type="integer">People added to `campaignId`.</ResponseField>
  </Expandable>
</ResponseField>

<RequestExample>
```bash cURL
curl -X POST "https://api.foxreach.io/api/v1/lead-finder/lists/lst_abc123/add-to-leads" \
  -H "X-API-Key: otr_your_key"
```

```python Python SDK
from foxreach import FoxReach

client = FoxReach(api_key="otr_your_key")
result = client.lead_finder.add_list_to_leads("lst_abc123")
```

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

const client = new FoxReach({ apiKey: "otr_your_key" });
const result = await client.leadFinder.addListToLeads("lst_abc123");
```
</RequestExample>

<ResponseExample>
```json
{
  "data": {"added": 3, "restored": 0, "alreadyInLeads": 1, "blocked": 0, "skipped": 0, "addedToCampaign": 0}
}
```
</ResponseExample>

## Errors

| Status | Description |
|--------|-------------|
| `401` | Missing, invalid, revoked or expired API key |
| `403` | API key does not have the required scope: `write` |
| `404` | `Lead Finder is not enabled` while Lead Finder is switched off on this environment |
| `503` | `Lead Finder is not configured` when it is enabled but has no data provider key |
| `404` | `List not found`: the list does not exist in this workspace |
| `402` | `upgrade_required`: adding them would pass the plan's contact limit |
| `404` | `Campaign not found` when `campaignId` is not in this workspace |
| `422` | The list is a company list |

## Rate Limit

- **100 requests per minute, shared by every `bulk` 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` (`bulk`).
- A `429` response includes a `Retry-After` header (seconds until the bucket resets).

For client-side patterns, see [Rate Limiting](/rate-limiting).