POST
/
leads
curl --request POST \
  --url https://app.prontohq.com/api/v2/leads \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '{
  "search_url": "<string>",
  "webhook_url": "<string>",
  "name": "<string>",
  "streaming": true,
  "custom": {
    "hubspot_id": "134567"
  },
  "limit": 100
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "processing"
}

Authorizations

​
X-API-KEY
string
header
required

Your API key

Body

application/json
Lead search parameters
​
search_url
string
required

The LinkedIn search URL to extract leads from

​
name
string
required

Name of the lead search

​
webhook_url
string

Optional webhook URL to receive notifications when the search is complete

​
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

202
application/json
Lead search initiated successfully
​
id
string

The ID of the created lead search

​
status
enum<string>

The status of the lead search

Available options:
processing