Get lead

Gets a lead by ID

Parameters

Function GetLead(Val URL, Val LeadID, Val Token = "") Export

Parameter	CLI option	Type	Required	Description
URL	--url	String	✔	URL of webhook or a Bitrix24 domain, when token used
LeadID	--lead	Number, String	✔	Lead ID
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.get

1C:Enterprise/OneScript code example

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

    Result = OPI_Bitrix24.GetLead(URL, LeadID);

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

    Result = OPI_Bitrix24.GetLead(URL, LeadID, Token);

Bash

    oint bitrix24 GetLead \
      --url "b24-ar17wx.bitrix24.by" \
      --lead 3570 \
      --token "***"

CMD/Bat

    oint bitrix24 GetLead ^
      --url "b24-ar17wx.bitrix24.by" ^
      --lead 3570 ^
      --token "***"

Result

{
 "result": {
  "ID": "3570",
  "TITLE": "MegaClient",
  "HONORIFIC": null,
  "NAME": "Ivan",
  "SECOND_NAME": null,
  "LAST_NAME": "Ivanov",
  "COMPANY_TITLE": null,
  "COMPANY_ID": null,
  "CONTACT_ID": "3570",
  "IS_RETURN_CUSTOMER": "N",
  "BIRTHDATE": "",
  "SOURCE_ID": "CALL",
  "SOURCE_DESCRIPTION": null,
  "STATUS_ID": "CONVERTED",
  "STATUS_DESCRIPTION": null,
  "POST": null,
  "COMMENTS": null,
  "CURRENCY_ID": "BYN",
  "OPPORTUNITY": "0.00",
  "IS_MANUAL_OPPORTUNITY": "N",
  "HAS_PHONE": "***",
  "HAS_EMAIL": "Y",
  "HAS_IMOL": "N",
  "ASSIGNED_BY_ID": "1",
  "CREATED_BY_ID": "1",
  "MODIFY_BY_ID": "1",
  "DATE_CREATE": "2026-05-26T14:15:53+00:00",
  "DATE_MODIFY": "2026-05-26T14:15:54+00:00",
  "DATE_CLOSED": "2026-05-25T21:00:00+00:00",
  "STATUS_SEMANTIC_ID": "S",
  "OPENED": "Y",
  "ORIGINATOR_ID": "***",
  "ORIGIN_ID": "***",
  "MOVED_BY_ID": "1",
  "MOVED_TIME": "2026-05-26T14:15:54+00:00",
  "ADDRESS": "Pushkin st., b. 10",
  "ADDRESS_2": null,
  "ADDRESS_CITY": null,
  "ADDRESS_POSTAL_CODE": null,
  "ADDRESS_REGION": null,
  "ADDRESS_PROVINCE": null,
  "ADDRESS_COUNTRY": "Russia",
  "ADDRESS_COUNTRY_CODE": null,
  "ADDRESS_LOC_ADDR_ID": "7142",
  "UTM_SOURCE": null,
  "UTM_MEDIUM": null,
  "UTM_CAMPAIGN": null,
  "UTM_CONTENT": null,
  "UTM_TERM": null,
  "LAST_COMMUNICATION_TIME": null,
  "LAST_ACTIVITY_BY": "1",
  "LAST_ACTIVITY_TIME": "2026-05-26T14:15:53+00:00",
  "EMAIL": [
   {
    "ID": "21410",
    "VALUE_TYPE": "HOME",
    "VALUE": "yo@example.com",
    "TYPE_ID": "EMAIL"
   },
   {
    "ID": "21412",
    "VALUE_TYPE": "WORK",
    "VALUE": "hi@example.com",
    "TYPE_ID": "EMAIL"
   }
  ],
  "PHONE": [
   {
    "ID": "21414",
    "VALUE_TYPE": "WORK",
    "VALUE": "88005553535",
    "TYPE_ID": "PHONE"
   }
  ]
 },
 "time": {
  "start": 1779804956,
  "finish": 1779804956.39517,
  "duration": 0.395169019699097,
  "processing": 0,
  "date_start": "2026-05-26T14:15:56+00:00",
  "date_finish": "2026-05-26T14:15:56+00:00",
  "operating_reset_at": 1779805556,
  "operating": 0
 }
}