Leads
List leads with pagination and filters
POST
/
leads
/
list
List leads with pagination and filters
curl --request POST \
--url https://api.breakcold.com/rest/leads/list \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"cursor": 123,
"filter": {
"leads": [
"<string>"
],
"not_leads": [
"<string>"
],
"is_company": true,
"is_contract": true,
"is_tracked": true,
"ai_enabled": true,
"search": "<string>",
"has_icebreaker": true,
"tags": [
"<string>"
],
"status": [
"<string>"
],
"has_list": true,
"has_no_list": true,
"lists": [
"<string>"
],
"has_owner": true,
"has_no_owner": true,
"owners": [
"<string>"
],
"score": [
"<string>"
],
"attributes": [
{
"id": "<string>",
"value": "<string>"
}
]
},
"pagination": {
"page": 0,
"page_size": 30
},
"orderBy": [
{
"field": "created_at",
"type": "desc"
}
],
"include": true,
"id_only": true,
"mode": "default"
}
'import requests
url = "https://api.breakcold.com/rest/leads/list"
payload = {
"cursor": 123,
"filter": {
"leads": ["<string>"],
"not_leads": ["<string>"],
"is_company": True,
"is_contract": True,
"is_tracked": True,
"ai_enabled": True,
"search": "<string>",
"has_icebreaker": True,
"tags": ["<string>"],
"status": ["<string>"],
"has_list": True,
"has_no_list": True,
"lists": ["<string>"],
"has_owner": True,
"has_no_owner": True,
"owners": ["<string>"],
"score": ["<string>"],
"attributes": [
{
"id": "<string>",
"value": "<string>"
}
]
},
"pagination": {
"page": 0,
"page_size": 30
},
"orderBy": [
{
"field": "created_at",
"type": "desc"
}
],
"include": True,
"id_only": True,
"mode": "default"
}
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({
cursor: 123,
filter: {
leads: ['<string>'],
not_leads: ['<string>'],
is_company: true,
is_contract: true,
is_tracked: true,
ai_enabled: true,
search: '<string>',
has_icebreaker: true,
tags: ['<string>'],
status: ['<string>'],
has_list: true,
has_no_list: true,
lists: ['<string>'],
has_owner: true,
has_no_owner: true,
owners: ['<string>'],
score: ['<string>'],
attributes: [{id: '<string>', value: '<string>'}]
},
pagination: {page: 0, page_size: 30},
orderBy: [{field: 'created_at', type: 'desc'}],
include: true,
id_only: true,
mode: 'default'
})
};
fetch('https://api.breakcold.com/rest/leads/list', 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/list",
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([
'cursor' => 123,
'filter' => [
'leads' => [
'<string>'
],
'not_leads' => [
'<string>'
],
'is_company' => true,
'is_contract' => true,
'is_tracked' => true,
'ai_enabled' => true,
'search' => '<string>',
'has_icebreaker' => true,
'tags' => [
'<string>'
],
'status' => [
'<string>'
],
'has_list' => true,
'has_no_list' => true,
'lists' => [
'<string>'
],
'has_owner' => true,
'has_no_owner' => true,
'owners' => [
'<string>'
],
'score' => [
'<string>'
],
'attributes' => [
[
'id' => '<string>',
'value' => '<string>'
]
]
],
'pagination' => [
'page' => 0,
'page_size' => 30
],
'orderBy' => [
[
'field' => 'created_at',
'type' => 'desc'
]
],
'include' => true,
'id_only' => true,
'mode' => 'default'
]),
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/list"
payload := strings.NewReader("{\n \"cursor\": 123,\n \"filter\": {\n \"leads\": [\n \"<string>\"\n ],\n \"not_leads\": [\n \"<string>\"\n ],\n \"is_company\": true,\n \"is_contract\": true,\n \"is_tracked\": true,\n \"ai_enabled\": true,\n \"search\": \"<string>\",\n \"has_icebreaker\": true,\n \"tags\": [\n \"<string>\"\n ],\n \"status\": [\n \"<string>\"\n ],\n \"has_list\": true,\n \"has_no_list\": true,\n \"lists\": [\n \"<string>\"\n ],\n \"has_owner\": true,\n \"has_no_owner\": true,\n \"owners\": [\n \"<string>\"\n ],\n \"score\": [\n \"<string>\"\n ],\n \"attributes\": [\n {\n \"id\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n },\n \"pagination\": {\n \"page\": 0,\n \"page_size\": 30\n },\n \"orderBy\": [\n {\n \"field\": \"created_at\",\n \"type\": \"desc\"\n }\n ],\n \"include\": true,\n \"id_only\": true,\n \"mode\": \"default\"\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/list")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"cursor\": 123,\n \"filter\": {\n \"leads\": [\n \"<string>\"\n ],\n \"not_leads\": [\n \"<string>\"\n ],\n \"is_company\": true,\n \"is_contract\": true,\n \"is_tracked\": true,\n \"ai_enabled\": true,\n \"search\": \"<string>\",\n \"has_icebreaker\": true,\n \"tags\": [\n \"<string>\"\n ],\n \"status\": [\n \"<string>\"\n ],\n \"has_list\": true,\n \"has_no_list\": true,\n \"lists\": [\n \"<string>\"\n ],\n \"has_owner\": true,\n \"has_no_owner\": true,\n \"owners\": [\n \"<string>\"\n ],\n \"score\": [\n \"<string>\"\n ],\n \"attributes\": [\n {\n \"id\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n },\n \"pagination\": {\n \"page\": 0,\n \"page_size\": 30\n },\n \"orderBy\": [\n {\n \"field\": \"created_at\",\n \"type\": \"desc\"\n }\n ],\n \"include\": true,\n \"id_only\": true,\n \"mode\": \"default\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.breakcold.com/rest/leads/list")
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 \"cursor\": 123,\n \"filter\": {\n \"leads\": [\n \"<string>\"\n ],\n \"not_leads\": [\n \"<string>\"\n ],\n \"is_company\": true,\n \"is_contract\": true,\n \"is_tracked\": true,\n \"ai_enabled\": true,\n \"search\": \"<string>\",\n \"has_icebreaker\": true,\n \"tags\": [\n \"<string>\"\n ],\n \"status\": [\n \"<string>\"\n ],\n \"has_list\": true,\n \"has_no_list\": true,\n \"lists\": [\n \"<string>\"\n ],\n \"has_owner\": true,\n \"has_no_owner\": true,\n \"owners\": [\n \"<string>\"\n ],\n \"score\": [\n \"<string>\"\n ],\n \"attributes\": [\n {\n \"id\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n },\n \"pagination\": {\n \"page\": 0,\n \"page_size\": 30\n },\n \"orderBy\": [\n {\n \"field\": \"created_at\",\n \"type\": \"desc\"\n }\n ],\n \"include\": true,\n \"id_only\": true,\n \"mode\": \"default\"\n}"
response = http.request(request)
puts response.read_body{
"leads": [
{
"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>"
}
],
"pagination": {
"page": 0,
"page_size": 30
},
"total": 123
}{
"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
Was this page helpful?
⌘I
List leads with pagination and filters
curl --request POST \
--url https://api.breakcold.com/rest/leads/list \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"cursor": 123,
"filter": {
"leads": [
"<string>"
],
"not_leads": [
"<string>"
],
"is_company": true,
"is_contract": true,
"is_tracked": true,
"ai_enabled": true,
"search": "<string>",
"has_icebreaker": true,
"tags": [
"<string>"
],
"status": [
"<string>"
],
"has_list": true,
"has_no_list": true,
"lists": [
"<string>"
],
"has_owner": true,
"has_no_owner": true,
"owners": [
"<string>"
],
"score": [
"<string>"
],
"attributes": [
{
"id": "<string>",
"value": "<string>"
}
]
},
"pagination": {
"page": 0,
"page_size": 30
},
"orderBy": [
{
"field": "created_at",
"type": "desc"
}
],
"include": true,
"id_only": true,
"mode": "default"
}
'import requests
url = "https://api.breakcold.com/rest/leads/list"
payload = {
"cursor": 123,
"filter": {
"leads": ["<string>"],
"not_leads": ["<string>"],
"is_company": True,
"is_contract": True,
"is_tracked": True,
"ai_enabled": True,
"search": "<string>",
"has_icebreaker": True,
"tags": ["<string>"],
"status": ["<string>"],
"has_list": True,
"has_no_list": True,
"lists": ["<string>"],
"has_owner": True,
"has_no_owner": True,
"owners": ["<string>"],
"score": ["<string>"],
"attributes": [
{
"id": "<string>",
"value": "<string>"
}
]
},
"pagination": {
"page": 0,
"page_size": 30
},
"orderBy": [
{
"field": "created_at",
"type": "desc"
}
],
"include": True,
"id_only": True,
"mode": "default"
}
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({
cursor: 123,
filter: {
leads: ['<string>'],
not_leads: ['<string>'],
is_company: true,
is_contract: true,
is_tracked: true,
ai_enabled: true,
search: '<string>',
has_icebreaker: true,
tags: ['<string>'],
status: ['<string>'],
has_list: true,
has_no_list: true,
lists: ['<string>'],
has_owner: true,
has_no_owner: true,
owners: ['<string>'],
score: ['<string>'],
attributes: [{id: '<string>', value: '<string>'}]
},
pagination: {page: 0, page_size: 30},
orderBy: [{field: 'created_at', type: 'desc'}],
include: true,
id_only: true,
mode: 'default'
})
};
fetch('https://api.breakcold.com/rest/leads/list', 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/list",
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([
'cursor' => 123,
'filter' => [
'leads' => [
'<string>'
],
'not_leads' => [
'<string>'
],
'is_company' => true,
'is_contract' => true,
'is_tracked' => true,
'ai_enabled' => true,
'search' => '<string>',
'has_icebreaker' => true,
'tags' => [
'<string>'
],
'status' => [
'<string>'
],
'has_list' => true,
'has_no_list' => true,
'lists' => [
'<string>'
],
'has_owner' => true,
'has_no_owner' => true,
'owners' => [
'<string>'
],
'score' => [
'<string>'
],
'attributes' => [
[
'id' => '<string>',
'value' => '<string>'
]
]
],
'pagination' => [
'page' => 0,
'page_size' => 30
],
'orderBy' => [
[
'field' => 'created_at',
'type' => 'desc'
]
],
'include' => true,
'id_only' => true,
'mode' => 'default'
]),
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/list"
payload := strings.NewReader("{\n \"cursor\": 123,\n \"filter\": {\n \"leads\": [\n \"<string>\"\n ],\n \"not_leads\": [\n \"<string>\"\n ],\n \"is_company\": true,\n \"is_contract\": true,\n \"is_tracked\": true,\n \"ai_enabled\": true,\n \"search\": \"<string>\",\n \"has_icebreaker\": true,\n \"tags\": [\n \"<string>\"\n ],\n \"status\": [\n \"<string>\"\n ],\n \"has_list\": true,\n \"has_no_list\": true,\n \"lists\": [\n \"<string>\"\n ],\n \"has_owner\": true,\n \"has_no_owner\": true,\n \"owners\": [\n \"<string>\"\n ],\n \"score\": [\n \"<string>\"\n ],\n \"attributes\": [\n {\n \"id\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n },\n \"pagination\": {\n \"page\": 0,\n \"page_size\": 30\n },\n \"orderBy\": [\n {\n \"field\": \"created_at\",\n \"type\": \"desc\"\n }\n ],\n \"include\": true,\n \"id_only\": true,\n \"mode\": \"default\"\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/list")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"cursor\": 123,\n \"filter\": {\n \"leads\": [\n \"<string>\"\n ],\n \"not_leads\": [\n \"<string>\"\n ],\n \"is_company\": true,\n \"is_contract\": true,\n \"is_tracked\": true,\n \"ai_enabled\": true,\n \"search\": \"<string>\",\n \"has_icebreaker\": true,\n \"tags\": [\n \"<string>\"\n ],\n \"status\": [\n \"<string>\"\n ],\n \"has_list\": true,\n \"has_no_list\": true,\n \"lists\": [\n \"<string>\"\n ],\n \"has_owner\": true,\n \"has_no_owner\": true,\n \"owners\": [\n \"<string>\"\n ],\n \"score\": [\n \"<string>\"\n ],\n \"attributes\": [\n {\n \"id\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n },\n \"pagination\": {\n \"page\": 0,\n \"page_size\": 30\n },\n \"orderBy\": [\n {\n \"field\": \"created_at\",\n \"type\": \"desc\"\n }\n ],\n \"include\": true,\n \"id_only\": true,\n \"mode\": \"default\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.breakcold.com/rest/leads/list")
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 \"cursor\": 123,\n \"filter\": {\n \"leads\": [\n \"<string>\"\n ],\n \"not_leads\": [\n \"<string>\"\n ],\n \"is_company\": true,\n \"is_contract\": true,\n \"is_tracked\": true,\n \"ai_enabled\": true,\n \"search\": \"<string>\",\n \"has_icebreaker\": true,\n \"tags\": [\n \"<string>\"\n ],\n \"status\": [\n \"<string>\"\n ],\n \"has_list\": true,\n \"has_no_list\": true,\n \"lists\": [\n \"<string>\"\n ],\n \"has_owner\": true,\n \"has_no_owner\": true,\n \"owners\": [\n \"<string>\"\n ],\n \"score\": [\n \"<string>\"\n ],\n \"attributes\": [\n {\n \"id\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n },\n \"pagination\": {\n \"page\": 0,\n \"page_size\": 30\n },\n \"orderBy\": [\n {\n \"field\": \"created_at\",\n \"type\": \"desc\"\n }\n ],\n \"include\": true,\n \"id_only\": true,\n \"mode\": \"default\"\n}"
response = http.request(request)
puts response.read_body{
"leads": [
{
"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>"
}
],
"pagination": {
"page": 0,
"page_size": 30
},
"total": 123
}{
"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": []
}