Create Lead List (Lead Discovery)

Starts a lead discovery process that scrapes Facebook or Google Ads to find potential leads. Results are saved to a new or existing lead list.

Lead lists contain companies, and leads are people attached to those companies. Discovery stores the process leadListId, attaches discovered companies to that list, and stores discovered contacts under each company.

Request

• searchTerm (string) (required) — The keyword to search for in ads (e.g., "Solar installation", "dentist")

• leadCount (integer) (default: 100) — Maximum number of leads to discover

• adReachedCountries (string[]) (default: [) — Countries to filter ads by (ISO 2-letter codes)

• leadListId (integer) — Existing lead list ID to add results to. Creates a new list if not provided.

curl -X POST https://api.hermes.camie.ai/v1/leads/process \
  -H "Authorization: Bearer hermes_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "searchTerm": "Solar installation",
    "leadCount": 100,
    "adReachedCountries": ["GB"],
    "leadListId": 1
  }'

const res = await fetch('https://api.hermes.camie.ai/v1/leads/process', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer hermes_your_api_key',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    searchTerm: 'Solar installation',
    leadCount: 100,
    adReachedCountries: ['GB'],
    leadListId: 1
  })
});

Response (201 Created)

{
  "success": true,
  "message": "Process started",
  "data": {
    "id": 4,
    "userId": "3dd2d062-...",
    "leadListId": 1,
    "leadCount": 100,
    "processedLeads": 0,
    "foundLeads": 0,
    "searchTerm": "Solar installation",
    "adReachedCountries": ["GB"],
    "status": "processing",
    "createdAt": "2026-03-14T16:00:00.000Z"
  }
}

📝 Note: Lead discovery runs asynchronously. Use Process Status to track progress.

How It Works

1. Hermes searches Facebook/Google Ad Libraries for your keyword
2. Extracts company information from matching ads
3. AI-enriches company data to find contact details
4. Validates email addresses
5. Attaches companies to the lead list and stores contacts as leads under those companies

Typical processing time: 5–30 minutes depending on leadCount.