API Documentation
Status
Workspaces
Leads
- POSTCreate a lead
- GETGet a lead by id
- DELDelete a lead
- PATCHUpdate a lead
- POSTDelete many leads
- PATCHUpdate many leads
- POSTList leads with pagination and filters
- POSTAdd a list to leads
- POSTTrack a lead
- GETGet count of tracked leads
- POSTTrack leads
- POSTConnect a lead to a company
- POSTDisconnect a lead from a company
- POSTSearch leads
Lists
Campaigns
Reminders
Leads
Search leads
POST
/
leads
/
search
Copy
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>"
}'
Copy
{
"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": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"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_tracked": true,
"is_deleted": true,
"is_deleted_at": "2023-11-07T05:31:56Z",
"company_enrich": "<string>",
"custom_fields": "<string>",
"custom_fields_schema": "<string>",
"order": 123,
"contract_value": 123,
"contract_currency": "<string>",
"score": 123,
"id_linkedin_company": "<string>",
"id_linkedin": "<string>",
"id_space": "<string>",
"id_twitter_company": "<string>",
"id_twitter": "<string>",
"usersId": "<string>"
}
Authorizations
Body
application/json
Response
200
application/json
Successful response
The response is of type object
.
The response is of type object
.
The response is of type null
.
Copy
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>"
}'
Copy
{
"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": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"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_tracked": true,
"is_deleted": true,
"is_deleted_at": "2023-11-07T05:31:56Z",
"company_enrich": "<string>",
"custom_fields": "<string>",
"custom_fields_schema": "<string>",
"order": 123,
"contract_value": 123,
"contract_currency": "<string>",
"score": 123,
"id_linkedin_company": "<string>",
"id_linkedin": "<string>",
"id_space": "<string>",
"id_twitter_company": "<string>",
"id_twitter": "<string>",
"usersId": "<string>"
}
Assistant
Responses are generated using AI and may contain mistakes.