OpenIntegrations/docs/en/md/Bitrix24/Leads-managment/Get-lead-structure.md

sidebar_position

sidebar_position
6

Get lead structure

Gets a structure with field descriptions for creating a lead

Function GetLeadStructure(Val URL, Val Token = "") Export

Parameter	CLI option	Type	Description
URL	--url	String	URL of webhook or a Bitrix24 domain, when token used
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.fields :::

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

    Result = OPI_Bitrix24.GetLeadStructure(URL);

    URL   = "b24-ar17wx.bitrix24.by";
    Token = "6476c766006e9f06006b12e400000001000...";

    Result = OPI_Bitrix24.GetLeadStructure(URL, Token);

    
  oint bitrix24 GetLeadStructure --url "b24-ar17wx.bitrix24.by" --token "ec4dc366006e9f06006b12e400000001000..."