Breakcold home page
v3
Search...
Login
Support
Login
Search...
Navigation
Leads
Search leads
Documentation
API Reference
Knowledge Base
API Reference
API Documentation
Introduction
User
GET
Get user details
Status
GET
List status
POST
Create a status
PATCH
Update many status
DEL
Delete a status
PATCH
Update a status
Workspaces
GET
Get user workspaces
Members
GET
Get members of a workspace
Leads
POST
Create Lead
GET
Get a lead by id
DEL
Delete a lead
PATCH
Update Lead
POST
Delete many leads
PATCH
Update many leads
POST
List leads with pagination and filters
POST
Add a list to leads
POST
Track a lead
GET
Get count of tracked leads
POST
Track leads
POST
Connect a lead to a company
POST
Disconnect a lead from a company
POST
Search leads
Tags
GET
List tags
POST
Create a tag
DEL
Delete a tag
PATCH
Update a tag
Lists
POST
Add many leads to a list
POST
Move many leads to a list
POST
Remove many leads from a list
GET
Get all lists
POST
Create a list
DEL
Delete a list
PATCH
Update a list
PATCH
Move the order of a list
POST
Connect a list to a campaign
DEL
Remove a list from a campaign
Notes
POST
List notes
POST
Create a note
GET
Get a note
DEL
Delete a note
PATCH
Update a note
Campaigns
GET
List campaigns
Reminders
POST
List reminders with filters and pagination
GET
Get a reminder
DEL
Delete a reminder
PATCH
Update a reminder
POST
Create a reminder
Attributes
GET
List attributes
POST
Create an attributes
DEL
Delete an attribute
PATCH
Update an attribute
GET
List attributes for Zapier
GET
List attributes for Make
Leads
Search leads
POST
/
leads
/
search
Send
Authorization
X-API-KEY
string
*
X-API-KEY
Required
string
Body
object
*
email
string
email
string
linkedin_url
string
linkedin_url
string
twitter_name
string
twitter_name
string
facebook_username
string
facebook_username
string
youtube_username
string
youtube_username
string
phone
string
phone
string
instagram_username
string
instagram_username
string
telegram_username
string
telegram_username
string
whatsapp_username
string
whatsapp_username
string
Authorizations
X-API-KEY
string
header
required
Body
application/json
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
Response
200 - application/json
Option 1
Option 2
id
string
required
email
string | null
required
company
string | null
required
phone
string | null
required
linkedin_url
string | null
required
linkedin_company_url
string | null
required
facebook_username
string | null
required
youtube_username
string | null
required
instagram_username
string | null
required
telegram_username
string | null
required
whatsapp_username
string | null
required
search_query
string | null
required
created_at
string
required
updated_at
string | null
required
first_name
string | null
required
icebreaker
string | null
required
last_name
string | null
required
website_url
string | null
required
timezone
string | null
required
city
string | null
required
company_role
string | null
required
twitter_name
string | null
required
avatar_url
string | null
required
icebreaker_2
string | null
required
icebreaker_3
string | null
required
icebreaker_4
string | null
required
email_bounce_score
integer | null
required
twitter_company_name
string | null
required
is_company
boolean
required
is_tracked
boolean | null
required
is_deleted
boolean
required
is_deleted_at
string | null
required
company_enrich
Option 1 · string
Option 2 · number
Option 3 · boolean
Option 4 · object
Option 5 · object
Option 6 · any[]
required
custom_fields
Option 1 · string
Option 2 · number
Option 3 · boolean
Option 4 · object
Option 5 · object
Option 6 · any[]
required
custom_fields_schema
Option 1 · string
Option 2 · number
Option 3 · boolean
Option 4 · object
Option 5 · object
Option 6 · any[]
required
order
integer
required
contract_value
integer | null
required
contract_currency
string | null
required
score
integer | null
required
id_linkedin_company
string | null
required
id_linkedin
string | null
required
id_space
string | null
required
id_twitter_company
string | null
required
id_twitter
string | null
required
usersId
string | null
required
Disconnect a lead from a company
List tags