POST
/
leads
/
list
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_tracked": true,
    "email_status": "all",
    "search": "<string>",
    "sequences_steps": {
      "id": [
        "<string>"
      ],
      "status": [
        "is_opened"
      ]
    },
    "campaigns": [
      "<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": "<any>",
  "orderBy": [
    {
      "field": "created_at",
      "type": "desc"
    }
  ],
  "include": 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": "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>"
    }
  ],
  "pagination": "<any>",
  "total": 123
}

Authorizations

X-API-KEY
string
header
required

Body

application/json
cursor
number
filter
object
pagination
orderBy
object[]
include
boolean
default:true
mode
enum<string>
default:default
Available options:
default,
pipeline

Response

200
application/json
Successful response
leads
object[]
required
total
number
required
pagination