POST
/
leads
/
search
curl --request POST \
  --url https://app.prontohq.com/api/v2/leads/search \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '{
  "name": "Software Engineer Search",
  "webhook_url": "https://example.com/webhook",
  "company_linkedin_id": "1234567890",
  "job_titles": [
    "Software Engineer",
    "Product Manager"
  ],
  "excluded_job_titles": [
    "Intern",
    "Contractor"
  ],
  "included_locations": [
    "105015875",
    "102221843"
  ],
  "excluded_locations": [
    "103644278"
  ],
  "streaming": true,
  "custom": {
    "hubspot_id": "134567"
  },
  "limit": 100
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "processing"
}

​
Location IDs Reference

Location IDs used in this endpoint can be found in our reference spreadsheet. If you need additional locations added to this list, please contact our support team.

Authorizations

​
X-API-KEY
string
header
required

Your API key

Body

application/json
Parameters for lead search by job title
​
company_linkedin_id
string
required

The LinkedIn ID of the company

Example:

"1234567890"

​
job_titles
string[]
required

List of job titles to search for

Example:
["Software Engineer", "Product Manager"]
​
name
string

Name of the lead search

Example:

"Software Engineer Search"

​
webhook_url
string

Optional webhook URL to receive results when the search is complete

Example:

"https://example.com/webhook"

​
excluded_job_titles
string[]

List of job titles to exclude from the search

Example:
["Intern", "Contractor"]
​
included_locations
string[]

List of LinkedIn location IDs that were included in the search

Example:
["105015875", "102221843"]
​
excluded_locations
string[]

List of LinkedIn location IDs that were excluded from the search

Example:
["103644278"]
​
streaming
boolean
default:false

When set to true, leads will be sent individually to the webhook_url as they are found. This is ideal for integration with platforms like Clay that process leads in real-time.

Example:

true

​
custom
object

Custom fields to include with the lead search that will be returned in the webhook (like crm id, etc.)

Example:
{ "hubspot_id": "134567" }
​
limit
integer

Optional parameter to limit the number of results returned. If not specified, all matching leads will be returned.

Required range: x >= 1
Example:

100

Response

201
application/json
Search initiated successfully
​
id
string

The ID of the created lead search

​
status
enum<string>

The status of the lead search

Available options:
processing