Get leads list

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

Parameters

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

Parameter	CLI option	Type	Required	Description
URL	--url	String	✔	URL of webhook or a Bitrix24 domain, when token used
Filter	--filter	Structure of KeyAndValue	✖	Lead filter structure. See GetLeadFilterStructure
Indent	--offset	Number, String	✖	Offset from the beginning of the list to get leads > 50 recursively
Token	--token	String	✖	Access token, when app auth method used

Returns

Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API

Advanced call ?

Parameter	Description
proxy	InternetProxy or a structure with fields Protocol, Host, Port, User, Password, UseOSAuthentication
timeout	Request execution timeout
adv_response	Formats the response as a complete HTTP structure with fields code, body, and headers
retries	Number of HTTP request send attempts on 5** status codes or internal client errors
dontwait	Creates a background job and returns its data (for 1C and OneScript only)

tip

Method at API documentation: crm.lead.list

1C:Enterprise/OneScript code example

    URL = "https://b24-ar17wx.bitrix24.by/rest/1/av5...";

    Result = OPI_Bitrix24.GetLeadsList(URL);

    URL   = "b24-ar17wx.bitrix24.by";
    Token = "a5b00469006e9f06006b12e400000001000...";

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

    Result = OPI_Bitrix24.GetLeadsList(URL, Filter, , Token);

Bash

    # JSON data can also be passed as a path to a .json file
    
    oint bitrix24 GetLeadsList \
      --url "b24-ar17wx.bitrix24.by" \
      --filter "{'TITLE':'MegaClient','HAS_EMAIL':'Y'}" \
      --token "***"

CMD/Bat

    :: JSON data can also be passed as a path to a .json file
    
    oint bitrix24 GetLeadsList ^
      --url "b24-ar17wx.bitrix24.by" ^
      --filter "{'TITLE':'MegaClient','HAS_EMAIL':'Y'}" ^
      --token "***"

Result

{
 "result": [],
 "total": 0,
 "time": {
  "start": 1784481273,
  "finish": 1784481273.4389,
  "duration": 0.438899993896484,
  "processing": 0,
  "date_start": "2026-07-19T17:14:33+00:00",
  "date_finish": "2026-07-19T17:14:33+00:00",
  "operating_reset_at": 1784481873,
  "operating": 0
 }
}