GET
/
leads
Retrieve a list of leads based on given criteria.
curl --request GET \
  --url https://api.breakcold.com/leads \
  --header 'X-API-KEY: <api-key>'
{
  "id_space": "123",
  "id_list": "abc",
  "page": 1,
  "page_size": 100,
  "leads": [
    "lead1",
    "lead2"
  ]
}

Authorizations

​
X-API-KEY
string
header
required

Query Parameters

​
id_space
string

Space identifier. If 'X-API-KEY' is provided, this parameter is optional.

​
id_list
string

Optional list identifier to filter leads.

​
page
integer

Optional page number for pagination.

​
page_size
integer

Optional number of items per page.

Response

200
application/json

Successful response with list of leads.

The response is of type any.