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

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

tip

Method at API documentation: crm.lead.list

1C:Enterprise/OneScript code example

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

    Result = OPI_Bitrix24.GetLeadsList(URL);

    URL   = "b24-ar17wx.bitrix24.by";
    Token = "2f4e4067006e9f06006b12e400000001000...";

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

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

Bash

    oint bitrix24 GetLeadsList \
     --url "b24-ar17wx.bitrix24.by" \
     --token "***"

CMD/Bat

    oint bitrix24 GetLeadsList ^
     --url "b24-ar17wx.bitrix24.by" ^
     --token "***"

Result

{
 "result": [],
 "total": 0,
 "time": {
  "start": 1728454939.89873,
  "finish": 1728454939.94382,
  "duration": 0.0450830459594727,
  "processing": 0.0179238319396973,
  "date_start": "2024-10-09T09:22:19+03:00",
  "date_finish": "2024-10-09T09:22:19+03:00",
  "operating_reset_at": 1728455539,
  "operating": 0
 }
}