Leads
Search leads
POST
/
leads
/
search
Search leads
curl --request POST \
--url https://api.breakcold.com/rest/leads/search \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"email": "<string>",
"linkedin_url": "<string>",
"twitter_name": "<string>",
"facebook_username": "<string>",
"youtube_username": "<string>",
"phone": "<string>",
"instagram_username": "<string>",
"telegram_username": "<string>",
"whatsapp_username": "<string>",
"website_url": "<string>",
"is_company": true,
"linkedin_company_url": "<string>",
"company": "<string>"
}
'import requests
url = "https://api.breakcold.com/rest/leads/search"
payload = {
"email": "<string>",
"linkedin_url": "<string>",
"twitter_name": "<string>",
"facebook_username": "<string>",
"youtube_username": "<string>",
"phone": "<string>",
"instagram_username": "<string>",
"telegram_username": "<string>",
"whatsapp_username": "<string>",
"website_url": "<string>",
"is_company": True,
"linkedin_company_url": "<string>",
"company": "<string>"
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
email: '<string>',
linkedin_url: '<string>',
twitter_name: '<string>',
facebook_username: '<string>',
youtube_username: '<string>',
phone: '<string>',
instagram_username: '<string>',
telegram_username: '<string>',
whatsapp_username: '<string>',
website_url: '<string>',
is_company: true,
linkedin_company_url: '<string>',
company: '<string>'
})
};
fetch('https://api.breakcold.com/rest/leads/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.breakcold.com/rest/leads/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'email' => '<string>',
'linkedin_url' => '<string>',
'twitter_name' => '<string>',
'facebook_username' => '<string>',
'youtube_username' => '<string>',
'phone' => '<string>',
'instagram_username' => '<string>',
'telegram_username' => '<string>',
'whatsapp_username' => '<string>',
'website_url' => '<string>',
'is_company' => true,
'linkedin_company_url' => '<string>',
'company' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.breakcold.com/rest/leads/search"
payload := strings.NewReader("{\n \"email\": \"<string>\",\n \"linkedin_url\": \"<string>\",\n \"twitter_name\": \"<string>\",\n \"facebook_username\": \"<string>\",\n \"youtube_username\": \"<string>\",\n \"phone\": \"<string>\",\n \"instagram_username\": \"<string>\",\n \"telegram_username\": \"<string>\",\n \"whatsapp_username\": \"<string>\",\n \"website_url\": \"<string>\",\n \"is_company\": true,\n \"linkedin_company_url\": \"<string>\",\n \"company\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.breakcold.com/rest/leads/search")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"<string>\",\n \"linkedin_url\": \"<string>\",\n \"twitter_name\": \"<string>\",\n \"facebook_username\": \"<string>\",\n \"youtube_username\": \"<string>\",\n \"phone\": \"<string>\",\n \"instagram_username\": \"<string>\",\n \"telegram_username\": \"<string>\",\n \"whatsapp_username\": \"<string>\",\n \"website_url\": \"<string>\",\n \"is_company\": true,\n \"linkedin_company_url\": \"<string>\",\n \"company\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.breakcold.com/rest/leads/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"<string>\",\n \"linkedin_url\": \"<string>\",\n \"twitter_name\": \"<string>\",\n \"facebook_username\": \"<string>\",\n \"youtube_username\": \"<string>\",\n \"phone\": \"<string>\",\n \"instagram_username\": \"<string>\",\n \"telegram_username\": \"<string>\",\n \"whatsapp_username\": \"<string>\",\n \"website_url\": \"<string>\",\n \"is_company\": true,\n \"linkedin_company_url\": \"<string>\",\n \"company\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "<string>",
"company": "<string>",
"phone": "<string>",
"linkedin_url": "<string>",
"linkedin_company_url": "<string>",
"facebook_username": "<string>",
"youtube_username": "<string>",
"instagram_username": "<string>",
"telegram_username": "<string>",
"whatsapp_username": "<string>",
"search_query": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"first_name": "<string>",
"icebreaker": "<string>",
"last_name": "<string>",
"website_url": "<string>",
"timezone": "<string>",
"city": "<string>",
"company_role": "<string>",
"twitter_name": "<string>",
"avatar_url": "<string>",
"icebreaker_2": "<string>",
"icebreaker_3": "<string>",
"icebreaker_4": "<string>",
"email_bounce_score": 123,
"twitter_company_name": "<string>",
"is_company": true,
"is_contract": true,
"is_tracked": true,
"is_deleted": true,
"is_deleted_at": "<string>",
"order": 123,
"contract_value": 123,
"contract_currency": "<string>",
"contract_name": "<string>",
"score": 123,
"ai_enabled": true,
"ai_enabled_at": "<string>",
"ai_summary": "<string>",
"ai_profile": "<string>",
"is_draft": true,
"last_interaction_at": "<string>",
"id_linkedin_company": "<string>",
"id_linkedin": "<string>",
"id_space": "<string>",
"usersId": "<string>"
}{
"code": "BAD_REQUEST",
"message": "Invalid input data",
"issues": []
}{
"code": "UNAUTHORIZED",
"message": "Authorization not provided",
"issues": []
}{
"code": "FORBIDDEN",
"message": "Insufficient access",
"issues": []
}{
"code": "INTERNAL_SERVER_ERROR",
"message": "Internal server error",
"issues": []
}Authorizations
Body
application/json
Response
object | null
Successful response
Was this page helpful?
⌘I
Search leads
curl --request POST \
--url https://api.breakcold.com/rest/leads/search \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"email": "<string>",
"linkedin_url": "<string>",
"twitter_name": "<string>",
"facebook_username": "<string>",
"youtube_username": "<string>",
"phone": "<string>",
"instagram_username": "<string>",
"telegram_username": "<string>",
"whatsapp_username": "<string>",
"website_url": "<string>",
"is_company": true,
"linkedin_company_url": "<string>",
"company": "<string>"
}
'import requests
url = "https://api.breakcold.com/rest/leads/search"
payload = {
"email": "<string>",
"linkedin_url": "<string>",
"twitter_name": "<string>",
"facebook_username": "<string>",
"youtube_username": "<string>",
"phone": "<string>",
"instagram_username": "<string>",
"telegram_username": "<string>",
"whatsapp_username": "<string>",
"website_url": "<string>",
"is_company": True,
"linkedin_company_url": "<string>",
"company": "<string>"
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
email: '<string>',
linkedin_url: '<string>',
twitter_name: '<string>',
facebook_username: '<string>',
youtube_username: '<string>',
phone: '<string>',
instagram_username: '<string>',
telegram_username: '<string>',
whatsapp_username: '<string>',
website_url: '<string>',
is_company: true,
linkedin_company_url: '<string>',
company: '<string>'
})
};
fetch('https://api.breakcold.com/rest/leads/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.breakcold.com/rest/leads/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'email' => '<string>',
'linkedin_url' => '<string>',
'twitter_name' => '<string>',
'facebook_username' => '<string>',
'youtube_username' => '<string>',
'phone' => '<string>',
'instagram_username' => '<string>',
'telegram_username' => '<string>',
'whatsapp_username' => '<string>',
'website_url' => '<string>',
'is_company' => true,
'linkedin_company_url' => '<string>',
'company' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.breakcold.com/rest/leads/search"
payload := strings.NewReader("{\n \"email\": \"<string>\",\n \"linkedin_url\": \"<string>\",\n \"twitter_name\": \"<string>\",\n \"facebook_username\": \"<string>\",\n \"youtube_username\": \"<string>\",\n \"phone\": \"<string>\",\n \"instagram_username\": \"<string>\",\n \"telegram_username\": \"<string>\",\n \"whatsapp_username\": \"<string>\",\n \"website_url\": \"<string>\",\n \"is_company\": true,\n \"linkedin_company_url\": \"<string>\",\n \"company\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.breakcold.com/rest/leads/search")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"<string>\",\n \"linkedin_url\": \"<string>\",\n \"twitter_name\": \"<string>\",\n \"facebook_username\": \"<string>\",\n \"youtube_username\": \"<string>\",\n \"phone\": \"<string>\",\n \"instagram_username\": \"<string>\",\n \"telegram_username\": \"<string>\",\n \"whatsapp_username\": \"<string>\",\n \"website_url\": \"<string>\",\n \"is_company\": true,\n \"linkedin_company_url\": \"<string>\",\n \"company\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.breakcold.com/rest/leads/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"<string>\",\n \"linkedin_url\": \"<string>\",\n \"twitter_name\": \"<string>\",\n \"facebook_username\": \"<string>\",\n \"youtube_username\": \"<string>\",\n \"phone\": \"<string>\",\n \"instagram_username\": \"<string>\",\n \"telegram_username\": \"<string>\",\n \"whatsapp_username\": \"<string>\",\n \"website_url\": \"<string>\",\n \"is_company\": true,\n \"linkedin_company_url\": \"<string>\",\n \"company\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "<string>",
"company": "<string>",
"phone": "<string>",
"linkedin_url": "<string>",
"linkedin_company_url": "<string>",
"facebook_username": "<string>",
"youtube_username": "<string>",
"instagram_username": "<string>",
"telegram_username": "<string>",
"whatsapp_username": "<string>",
"search_query": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"first_name": "<string>",
"icebreaker": "<string>",
"last_name": "<string>",
"website_url": "<string>",
"timezone": "<string>",
"city": "<string>",
"company_role": "<string>",
"twitter_name": "<string>",
"avatar_url": "<string>",
"icebreaker_2": "<string>",
"icebreaker_3": "<string>",
"icebreaker_4": "<string>",
"email_bounce_score": 123,
"twitter_company_name": "<string>",
"is_company": true,
"is_contract": true,
"is_tracked": true,
"is_deleted": true,
"is_deleted_at": "<string>",
"order": 123,
"contract_value": 123,
"contract_currency": "<string>",
"contract_name": "<string>",
"score": 123,
"ai_enabled": true,
"ai_enabled_at": "<string>",
"ai_summary": "<string>",
"ai_profile": "<string>",
"is_draft": true,
"last_interaction_at": "<string>",
"id_linkedin_company": "<string>",
"id_linkedin": "<string>",
"id_space": "<string>",
"usersId": "<string>"
}{
"code": "BAD_REQUEST",
"message": "Invalid input data",
"issues": []
}{
"code": "UNAUTHORIZED",
"message": "Authorization not provided",
"issues": []
}{
"code": "FORBIDDEN",
"message": "Insufficient access",
"issues": []
}{
"code": "INTERNAL_SERVER_ERROR",
"message": "Internal server error",
"issues": []
}