Add Lead Finder List Items

Save up to 200 people or companies to a list.

POSThttps://api.foxreach.io/api/v1/lead-finder/lists/{list_id}/items

Requires an API key with the write scope.

An item whose key is already in the list is updated, not duplicated. A list holds at most 5,000 items.

Path Parameters#

list_idstringpathrequired

The list id.

Body Parameters#

itemsarraybodyrequired

1 to 200 objects with key (1 to 512 characters, the person id or LinkedIn URL) and snapshot (an object with firstName, lastName, title, company, companyDomain and so on).

Response#

dataobject

Show data

addedinteger

New items.

updatedinteger

Existing items refreshed.

skippedinteger

Items not saved, for example past the 5,000 limit.

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
`422`	`items` is empty or longer than 200

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.

Request

cURL

curl -X POST "https://api.foxreach.io/api/v1/lead-finder/lists/lst_abc123/items" \
  -H "X-API-Key: otr_your_key" \
  -H "Content-Type: application/json" \
  -d '{"items": [{"key": "https://www.linkedin.com/in/ada", "snapshot": {"firstName": "Ada", "company": "Acme"}}]}'

Python SDK

from foxreach import FoxReach

client = FoxReach(api_key="otr_your_key")
client.lead_finder.add_items("lst_abc123", items=[{"key": "https://www.linkedin.com/in/ada", "snapshot": {"first_name": "Ada", "company": "Acme"}}])

TypeScript SDK

import { FoxReach } from "foxreach";

const client = new FoxReach({ apiKey: "otr_your_key" });
await client.leadFinder.addItems("lst_abc123", { items: [{ key: "https://www.linkedin.com/in/ada", snapshot: { firstName: "Ada", company: "Acme" } }] });

Response

JSON

{
  "data": {"added": 1, "updated": 0, "skipped": 0}
}

Was this page helpful?

View as MarkdownLast updated November 4, 2026