Skip to main content

Get leads list

Gets a list of leads (50 per request max) with or without filtering (see GetLeadFilterStructure)

Function GetLeadsList(Val URL, Val Filter = "", Val Indent = 0, Val Token = "") Export

ParameterCLI optionTypeRequiredDescription
URL--urlStringURL of webhook or a Bitrix24 domain, when token used
Filter--filterStructure of KeyAndValueLead filter structure (see GetLeadFilterStructure)
Indent--offsetNumber, StringOffset from the beginning of the list to get leads > 50 recursively
Token--tokenStringAccess token, when app auth method used

Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API


tip

Method at API documentation: crm.lead.list


1C:Enterprise/OneScript code example
    URL = "https://b24-ar17wx.bitrix24.by/rest/1/h0m...";

Result = OPI_Bitrix24.GetLeadsList(URL);

URL = "b24-ar17wx.bitrix24.by";
Token = "75d8c668006e9f06006b12e400000001000...";

Filter = New Structure;
Filter.Insert("TITLE" , "MegaClient");
Filter.Insert("HAS_EMAIL", "Y");

Result = OPI_Bitrix24.GetLeadsList(URL, Filter, , Token);
    oint bitrix24 GetLeadsList \
--url ""b24-ar17wx.bitrix24.by"" \
--filter ""/tmp/xstz3pxp.i2h.json"" \
--token "***"
Result
{
"result": [],
"total": 0,
"time": {
"start": 1757977031.96586,
"finish": 1757977032.00604,
"duration": 0.0401849746704102,
"processing": 0.0156421661376953,
"date_start": "2025-09-15T22:57:11+00:00",
"date_finish": "2025-09-15T22:57:12+00:00",
"operating_reset_at": 1757977631,
"operating": 0
}
}