Get deals list

Gets the list of deals (50 pcs per query max) with or without filtering

Parameters

Function GetDealsList(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	✖	Deals filter structure. See GetDealsFilterStructure
Indent	--offset	Number, String	✖	Offset from the beginning of the list to retrieve deals > 50 pcs 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.deal.list

1C:Enterprise/OneScript code example

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

    Result = OPI_Bitrix24.GetDealsList(URL);

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

    Filter = New Structure;
    Filter.Insert("TITLE"      , "Sale in RUB");
    Filter.Insert("CURRENCY_ID", "RUB");

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

Bash

    # JSON data can also be passed as a path to a .json file
    
    oint bitrix24 GetDealsList \
      --url "b24-ar17wx.bitrix24.by" \
      --filter "{'TITLE':'Sale in RUB','CURRENCY_ID':'RUB'}" \
      --token "***"

CMD/Bat

    :: JSON data can also be passed as a path to a .json file
    
    oint bitrix24 GetDealsList ^
      --url "b24-ar17wx.bitrix24.by" ^
      --filter "{'TITLE':'Sale in RUB','CURRENCY_ID':'RUB'}" ^
      --token "***"

Result

{
 "result": [],
 "total": 0,
 "time": {
  "start": 1779804975,
  "finish": 1779804975.14571,
  "duration": 0.145708084106445,
  "processing": 0,
  "date_start": "2026-05-26T14:16:15+00:00",
  "date_finish": "2026-05-26T14:16:15+00:00",
  "operating_reset_at": 1779805575,
  "operating": 0
 }
}