Call the CRM Entity Selection Dialog BX24.selectCRM

If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.

BX24.selectCRM({entityType: value, multiple: true, value:value}): void;

The function BX24.selectCRM invokes the system dialog for selecting a CRM entity.

Method Parameters

Required parameters are marked with *

Name
type

Description

entityType
array

Which types of objects to display in the dialog. Possible values:

  • lead — Leads
  • contact — Contacts
  • company — Companies
  • deal — Deals
  • quote — Estimates

multiple
boolean

Whether multiple objects can be selected. Default is false.

value
array

Which objects to initially add to the selected in the dialog. Works only if multiple = true.

What the handler receives:

{
            "lead": [
                {
                    "id": "L_1348",
                    "type": "lead",
                    "place": "lead",
                    "title": "Mint Guest #2 - Open Line Bitrix",
                    "desc": "Guest",
                    "url": "/crm/lead/show/1348/"
                }
            ],
            "contact": [
                {
                    "id": "C_2",
                    "type": "contact",
                    "place": "contact",
                    "title": "Vasiliy Pupkin",
                    "desc": "",
                    "url": "/crm/contact/show/2/",
                    "image": "/upload/resize_cache/crm/8b5/25_25_2/MM35_PG13.jpg"
                }
            ],
            "company": [],
            "deal": [],
            "quote": []
        }

Code Example

BX24.selectCRM(
            {
                entityType: ['lead', 'contact', 'company', 'deal', 'quote'],
                multiple: true,
                value: {lead:[1348,2,35], contact:[2], company:[4,3], deal:[1,2], quote:[1]}
            }, 
            function(){
                console.log(arguments);
            }
        )

How to Use Examples in Documentation

Continue Learning

Previous
Show Access Permission Selection Dialog
Next
Overview of Methods