Authorizations
Body
application/json
Response
Successful response
The response is of type object
.
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,
"email_status": "all",
"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>",
"operator": "equals"
}
]
},
"pagination": {
"all": true
},
"orderBy": [
{
"field": "created_at",
"type": "desc"
}
],
"include": true,
"id_only": true,
"mode": "default"
}'
{
"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>",
"company_enrich": {}
}
],
"pagination": {
"all": true
},
"total": 123
}
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,
"email_status": "all",
"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>",
"operator": "equals"
}
]
},
"pagination": {
"all": true
},
"orderBy": [
{
"field": "created_at",
"type": "desc"
}
],
"include": true,
"id_only": true,
"mode": "default"
}'
{
"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>",
"company_enrich": {}
}
],
"pagination": {
"all": true
},
"total": 123
}
Successful response
The response is of type object
.
Was this page helpful?