Skip to main content
POST
/
lead_finder
/
async
cURL
curl --request POST \
  --url https://app.bettercontact.rocks/api/v2/lead_finder/async \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "filters": {
    "company": {
      "include": [
        "<string>"
      ],
      "exclude": [
        "<string>"
      ]
    },
    "company_industry": {
      "include": [
        "it services and it consulting"
      ],
      "exclude": [
        "it services and it consulting"
      ]
    },
    "company_technology": {
      "include": [
        "<string>"
      ],
      "exclude": [
        "<string>"
      ]
    },
    "company_headcount_min": 5000000,
    "company_headcount_max": 5000000,
    "lead_fullname": {
      "include": [
        "<string>"
      ],
      "exclude": [
        "<string>"
      ]
    },
    "lead_linkedin_url": {
      "include": [
        "<string>"
      ],
      "exclude": [
        "<string>"
      ]
    },
    "lead_department": {
      "include": [
        "operations"
      ],
      "exclude": [
        "operations"
      ]
    },
    "lead_function": {
      "include": [
        "operations"
      ],
      "exclude": [
        "operations"
      ]
    },
    "lead_skills": {
      "include": [
        "<string>"
      ],
      "exclude": [
        "<string>"
      ]
    },
    "lead_job_title": {
      "include": [
        "<string>"
      ],
      "exclude": [
        "<string>"
      ],
      "exact_match": true
    },
    "lead_location": {
      "include": [
        "<string>"
      ],
      "exclude": [
        "<string>"
      ]
    },
    "lead_seniority": {
      "include": [
        "senior"
      ],
      "exclude": [
        "senior"
      ]
    }
  },
  "limit": 100,
  "offset": 101,
  "webhook": "<string>"
}
'
{
  "success": true,
  "message": "Lead finder request accepted.",
  "request_id": "bc39ffbfc24cf043b748"
}

Authorizations

​
X-API-Key
string
header
required

Body

application/json

Filters and parameters for lead finding

​
filters
object
required
​
limit
integer

Maximum number of results to return per request. Accepted values between 1 and 200. By default, up to 100 leads are returned

Required range: 1 <= x <= 200
Example:

100

​
offset
integer

Number of results to skip before returning matches. Use this to paginate through results when the total number of leads found (visible in the leads_found attribute of the response) exceeds the limit of the current request. For example, if leads_found is 350 and limit is 100, set offset to 101 to retrieve the next page of results.

Example:

101

​
webhook
string | null

Optional URL to receive results automatically

Response

Lead finder request accepted

​
success
boolean
Example:

true

​
message
string
Example:

"Lead finder request accepted."

​
request_id
string
Example:

"bc39ffbfc24cf043b748"