Skip to main content

Get deal

Gets deal by ID

Function GetDeal(Val URL, Val DealID, Val Token = "") Export

ParameterCLI optionTypeRequiredDescription
URL--urlString✔URL of webhook or a Bitrix24 domain, when token used
DealID--dealNumber, String✔Deal ID
Token--tokenString✖Access token, when app auth method used

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


tip

Method at API documentation: crm.deal.get


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

    Result = OPI_Bitrix24.GetDeal(URL, DealID);

    URL    = "b24-ar17wx.bitrix24.by";
    Token  = "8a1bee68006e9f06006b12e400000001000...";
    DealID = "5188";

    Result = OPI_Bitrix24.GetDeal(URL, DealID, Token);
    oint bitrix24 GetDeal \
     --url "b24-ar17wx.bitrix24.by" \
     --deal 5228 \
     --token "***"
Result
{
 "result": {
  "ID": "5228",
  "TITLE": "Planned sale",
  "TYPE_ID": "GOODS",
  "STAGE_ID": "NEW",
  "PROBABILITY": "30",
  "CURRENCY_ID": "USD",
  "OPPORTUNITY": "5000.00",
  "IS_MANUAL_OPPORTUNITY": "N",
  "TAX_VALUE": "0.00",
  "LEAD_ID": null,
  "COMPANY_ID": "1",
  "CONTACT_ID": "3",
  "QUOTE_ID": null,
  "BEGINDATE": "2024-01-01T00:00:00+00:00",
  "CLOSEDATE": "2030-01-01T00:00:00+00:00",
  "ASSIGNED_BY_ID": "1",
  "CREATED_BY_ID": "1",
  "MODIFY_BY_ID": "1",
  "DATE_CREATE": "2025-10-15T10:03:37+00:00",
  "DATE_MODIFY": "2025-10-15T10:03:37+00:00",
  "OPENED": "Y",
  "CLOSED": "N",
  "COMMENTS": null,
  "ADDITIONAL_INFO": null,
  "LOCATION_ID": null,
  "CATEGORY_ID": "0",
  "STAGE_SEMANTIC_ID": "P",
  "IS_NEW": "Y",
  "IS_RECURRING": "N",
  "IS_RETURN_CUSTOMER": "N",
  "IS_REPEATED_APPROACH": "N",
  "SOURCE_ID": "",
  "SOURCE_DESCRIPTION": null,
  "ORIGINATOR_ID": null,
  "ORIGIN_ID": null,
  "MOVED_BY_ID": "1",
  "MOVED_TIME": "2025-10-15T10:03:37+00:00",
  "LAST_ACTIVITY_TIME": "2025-10-15T10:03:37+00:00",
  "UTM_SOURCE": null,
  "UTM_MEDIUM": null,
  "UTM_CAMPAIGN": null,
  "UTM_CONTENT": null,
  "UTM_TERM": null,
  "LAST_COMMUNICATION_TIME": null,
  "LAST_ACTIVITY_BY": "1"
 },
 "time": {
  "start": 1760522626,
  "finish": 1760522626.88526,
  "duration": 0.885255098342896,
  "processing": 0,
  "date_start": "2025-10-15T10:03:46+00:00",
  "date_finish": "2025-10-15T10:03:46+00:00",
  "operating_reset_at": 1760523226,
  "operating": 0
 }
}