Skip to main content

Get deals list

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

Function GetDealsList(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 KeyAndValueDeals filter structure (see. GetDealsFilterStructure)
Indent--offsetNumber, StringOffset from the beginning of the list to retrieve deals > 50 pcs 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.deal.list


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

Result = OPI_Bitrix24.GetDealsList(URL);

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

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

Result = OPI_Bitrix24.GetDealsList(URL, Filter, , Token);
    oint bitrix24 GetDealsList \
--url ""b24-ar17wx.bitrix24.by"" \
--filter ""/tmp/ejvpyapn.3mv.json"" \
--token "***"
Result
{
"result": [],
"total": 0,
"time": {
"start": 1757977094.52778,
"finish": 1757977094.56748,
"duration": 0.0397078990936279,
"processing": 0.0178041458129883,
"date_start": "2025-09-15T22:58:14+00:00",
"date_finish": "2025-09-15T22:58:14+00:00",
"operating_reset_at": 1757977694,
"operating": 0
}
}