Sign in

v1

latestOpenAPI 3.1.02026-07-2617125852.3 KB
SuperSearchEnrichment

Preview leads from supersearch

Preview the leads matching a SuperSearch query without enriching them

Requires one of the following scopes: supersearch_enrichments:read, supersearch_enrichments:all, all:read, all:all

post/api/v2/supersearch-enrichment/preview-leads-from-supersearch

Request body

skip_owned_leadsboolean

Skip leads that belong to the current workspace

show_one_lead_per_companyboolean

Return only one lead per company

Example request

{
  "search_filters": {
    "locations": [
      {
        "place_id": "ChIJN1t_t3uEmsRUso9K6W47H4",
        "label": "San Francisco, CA, USA"
      }
    ],
    "department": [
      "Engineering"
    ],
    "level": [
      "Entry level"
    ],
    "employeeCount": [
      "0 - 25"
    ],
    "revenue": [
      "$1 - 10M"
    ],
    "news": [
      "launches"
    ],
    "jobListing": [
      "Software Engineer"
    ],
    "jobListingFilter": [
      "Software Engineer"
    ],
    "title": {
      "include": [
        "CEO"
      ],
      "exclude": [
        "VP"
      ]
    },
    "name": [
      "John Doe"
    ],
    "company_name": {
      "include": [
        "Google"
      ],
      "exclude": [
        "Amazon"
      ]
    },
    "look_alike": "google.com",
    "keyword_filter": {
      "exclude": "sales",
      "include": "marketing"
    },
    "industry": {
      "exclude": [
        "Agriculture & Mining"
      ],
      "include": [
        "Agriculture & Mining"
      ]
    },
    "subIndustry": {
      "exclude": [
        "Animation"
      ],
      "include": [
        "Animation"
      ]
    },
    "domains": [
      "google.com"
    ],
    "funding_type": [
      "angel"
    ],
    "signals": [
      "job_change"
    ],
    "skip_owned_leads": true,
    "show_one_lead_per_company": true,
    "location_mode": "contact"
  },
  "skip_owned_leads": true,
  "show_one_lead_per_company": true
}

Response

Default Response

number_of_leadsnumber

Number of leads found for this specific search. A value of 0 indicates that no leads match the criteria. Values greater than 1,000,000 are returned as 1,000,000.

number_of_redacted_resultsnumber

Number of results that were redacted/hidden (for trial users).

Example response

{
  "number_of_leads": 100,
  "leads": [
    {
      "firstName": "John",
      "lastName": "Doe",
      "fullName": "John Doe",
      "jobTitle": "Software Engineer",
      "location": "San Francisco, California, United States",
      "linkedIn": "linkedin.com/in/john-doe",
      "companyName": "Acme Corp",
      "companyLogo": "https://example.com/logo.png",
      "companyId": "123456"
    }
  ]
}