Client Search in the Entity Form CRM_DETAIL_SEARCH

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.

Scope: placement, crm

The CRM_DETAIL_SEARCH placement connects an application handler to the client search in the CRM form — to the Contact and Company fields of the Client block. Use it when the application searches for a client in an external source and fills the found option into the form.

The application does not render an interface of its own: it receives the search query and returns a list of options, while Bitrix24 displays them.

The placement code is specified in the PLACEMENT parameter of the placement.bind method.

The widget is not displayed in the interface until the application installation is complete. Check the application installation

Where the Widget is Embedded

Placement Code

Location

CRM_DETAIL_SEARCH

Application item in the client search of the CRM form

Where to Find It in the Interface

Open a CRM entity form and start typing a query into the Contact or Company field of the Client block. The application item appears below the list of found clients once the query is at least three characters long. The item is displayed with the name from the TITLE parameter.

Click the item to make the application run the search. While the handler responds, a loading indicator is shown on the item. The options found by the application appear in the same list as the clients of Bitrix24.

Application item in the client search of the deal form

What the Handler Receives

Data is sent in a POST request: some parameters come in the handler URL query string, the rest in the request body


        Array
        (
            [DOMAIN] => xxx.bitrix24.com
            [PROTOCOL] => 1
            [LANG] => en
            [APP_SID] => 1a7f0c3e59d84b2c7e6f5a83d1c40b92
            [AUTH_ID] => 83fd7166007e9c94001e30ba00000001f0f107a52e6ad7ef9a1b8c3d5e2f4061
            [AUTH_EXPIRES] => 3600
            [REFRESH_ID] => 737c9966007e9c94001e30ba00000001f0f1072b8d4e6f01a3c57d9e8b2f4160
            [SERVER_ENDPOINT] => https://oauth.bitrix.info/rest/
            [APPLICATION_TOKEN] => ec1b2074a9d3f5c81b6e40d27a95cf38
            [APPLICATION_SCOPE] => crm,placement
            [member_id] => d897063e1ce7c5eb9f04b9751eef5915
            [status] => L
            [PLACEMENT] => CRM_DETAIL_SEARCH
            [PLACEMENT_OPTIONS] => {"entityTypeName":"COMPANY","searchQuery":"Daisy","URI":"\/crm\/deal\/details\/5\/?any=details%2F5%2F&IFRAME=Y&IFRAME_TYPE=SIDE_SLIDER"}
        )
        
        

Required parameters are marked with *

Parameters in the Handler URL Query String

Parameter
type

Description

DOMAIN*
string

The Bitrix24 address where the widget handler was invoked

PROTOCOL*
string

Secure or non-secure HTTP protocol:

  • 0 - HTTP
  • 1 - HTTPS

LANG*
string

The user interface language of Bitrix24 that invoked the widget. You can localize the interface language in your widget based on this value

APP_SID*
string

Application session identifier. Bitrix24 generates a new one each time the widget is rendered and uses it to link the js library with the application environment

Parameters in the POST Request Body

Parameter
type

Description

AUTH_ID
string

Authorization token OAuth 2 issued for the user who invoked the widget. Can be used for REST API calls on behalf of this user

AUTH_EXPIRES
integer

Time in seconds after which the authorization token will become invalid

REFRESH_ID
string

Refresh token OAuth 2 issued for the user who invoked the widget. Can be used to refresh the authorization token on behalf of this user

SERVER_ENDPOINT*
string

Address of the Bitrix24 authorization server needed to refresh OAuth 2 tokens

APPLICATION_TOKEN*
string

Application token. The same value is passed in the application_token parameter when event handlers are invoked. The widget handler can use it to verify that the request came from Bitrix24

APPLICATION_SCOPE*
string

List of scopes granted to the application, separated by commas. Shows which REST API methods are available with the authorization token received

member_id*
string

Unique string identifier of Bitrix24 where the widget handler was invoked.

status
string

Type of application that registered the handler for this widget. Accepts values:

  • L - local application
  • F - free mass-market application
  • D - demo version of a mass-market application
  • T - trial version of a mass-market application, time-limited
  • P - paid mass-market application

PLACEMENT*
string

The placement code. You can use the same handler URL for all your widgets. The value that Bitrix24 will report in the PLACEMENT parameter will help determine from which specific placement your handler was invoked in each case

PLACEMENT_OPTIONS
string

Additional data in the form of a JSON string that defines the context of the widget execution. For example, this could be an array containing the numeric identifier of the CRM object in the detail form where the widget handler was invoked, etc. The PLACEMENT_OPTIONS parameter, along with the PLACEMENT parameter, allows you to accurately determine for which specific placement and object the widget handler was invoked

Bitrix24 adds a URI key to PLACEMENT_OPTIONS — the path with the query string of the page from which the widget was opened. It arrives for any placement, along with the keys of that placement itself. The key is absent if the browser did not send the Referer header or if the widget was opened from a page on a different domain.

PLACEMENT_OPTIONS

The PLACEMENT_OPTIONS value is passed as a JSON string with the call context. Besides the universal URI key, the context contains the keys of the placement itself.

Required parameters are marked with *

Parameter

Description

entityTypeName*
string

Type of the client the user is looking for.

Possible values:

  • CONTACT — the search runs in the Contact field
  • COMPANY — the search runs in the Company field

searchQuery*
string

The string the user typed into the search field

The identifier of the entity whose form the search was started from does not arrive as a separate key. It can be taken from the path in the universal URI key.

OPTIONS when registering via placement.bind

The placement does not support the OPTIONS parameters. Passed values are not saved: the placement.get method returns an empty array for such a registration.

How to Return the Found Options

Pass the found options with the BX24.placement.call method using the crmShowFoundEntities name.

Field
type

Description

data
array

List of the found options

data[].id
string

Identifier of the option on the application side

data[].name
string

Name of the option to be shown to the user

data[].phone
string

Phone of the option. Pass the field if the number is found

data[].email
string

Email of the option. Pass the field if the address is found

data[].web
string

Website of the option. Pass the field if the site is found

BX24.placement.call(
            'crmShowFoundEntities',
            {
                data: [
                    {
                        id: 'company-123',
                        name: 'Daisy Ltd',
                        phone: '+1 555 000-00-00',
                        email: 'info@example.com',
                        web: 'https://example.com'
                    }
                ]
            }
        );
        

If the application found nothing, pass an empty list. Bitrix24 will make the application item inactive.

How to Fill the Selected Option into the Form

If the user selects an option from the application response, Bitrix24 triggers the onCrmEntityIsNeedToCreate interface event. Subscribe to it with the BX24.placement.bindEvent method.

The event handler receives the data of the selected option.

Field
type

Description

appSid
string

Identifier of the application session in which the selected option was found

data
object

Data of the selected option from the list the application passed via crmShowFoundEntities

Create the entity in CRM with the crm.company.add or crm.contact.add method, and then pass its identifier with the crmShowCreatedEntity command. Bitrix24 fills this entity into the Client field of the form.

BX24.placement.bindEvent('onCrmEntityIsNeedToCreate', function (eventData) {
            const selected = eventData.data;
        
            BX24.placement.call(
                'crmShowCreatedEntity',
                {
                    entityType: 'company',
                    id: selected.id,
                    title: selected.title || selected.name
                }
            );
        });
        

Fields of the crmShowCreatedEntity command:

Field
type

Description

entityType
string

Type of the created entity. Pass company for a company and contact for a contact

id
string

Identifier of the created entity in CRM

title
string

Name of the created entity

Code Examples

How to Use Examples in Documentation

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{
            "PLACEMENT": "CRM_DETAIL_SEARCH",
            "HANDLER": "https://your-domain.com/widgets/crm-detail-search-handler.php",
            "TITLE": "Registry search",
            "LANG_ALL": {
              "en": {
                "TITLE": "Registry search"
              },
              "de": {
                "TITLE": "Registersuche"
              }
            },
            "auth": "**put_access_token_here**"
          }' \
          https://**put_your_bitrix24_address**/rest/placement.bind
        
// This snippet is an ES module: top-level await requires type="module" or a bundler.
        // $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
        import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        try {
          const response = await $b24.actions.v2.call.make<boolean>({
            method: 'placement.bind',
            params: {
              PLACEMENT: 'CRM_DETAIL_SEARCH',
              HANDLER: 'https://your-domain.com/widgets/crm-detail-search-handler.php',
              TITLE: 'Registry search',
              LANG_ALL: {
                en: {
                  TITLE: 'Registry search',
                },
                de: {
                  TITLE: 'Registersuche',
                },
              },
            },
            requestId: Text.getUuidRfc4122()
          })
        
          // The payload is available only on a successful response
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('Placement bound successfully:', result)
          }
        } catch (error) {
          // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
          console.error(error)
        }
        
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
        <script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
        <script>
          async function bindCrmDetailSearch() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'placement.bind',
                params: {
                  PLACEMENT: 'CRM_DETAIL_SEARCH',
                  HANDLER: 'https://your-domain.com/widgets/crm-detail-search-handler.php',
                  TITLE: 'Registry search',
                  LANG_ALL: {
                    en: {
                      TITLE: 'Registry search',
                    },
                    de: {
                      TITLE: 'Registersuche',
                    },
                  },
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              // The payload is available only on a successful response
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info('Placement bound successfully:', result)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', bindCrmDetailSearch)
        </script>
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'placement.bind',
                    [
                        'PLACEMENT' => 'CRM_DETAIL_SEARCH',
                        'HANDLER' => 'https://your-domain.com/widgets/crm-detail-search-handler.php',
                        'TITLE' => 'Registry search',
                        'LANG_ALL' => [
                            'en' => [
                                'TITLE' => 'Registry search',
                            ],
                            'de' => [
                                'TITLE' => 'Registersuche',
                            ],
                        ],
                    ]
                );
        
            $result = $response->getResponseData()->getResult();
            if ($result->error()) {
                error_log($result->error());
            } else {
                echo 'Success: ' . print_r($result->data(), true);
            }
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error binding placement: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'placement.bind',
            {
                PLACEMENT: 'CRM_DETAIL_SEARCH',
                HANDLER: 'https://your-domain.com/widgets/crm-detail-search-handler.php',
                TITLE: 'Registry search',
                LANG_ALL: {
                    en: { TITLE: 'Registry search' },
                    de: { TITLE: 'Registersuche' }
                }
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.log(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'placement.bind',
            [
                'PLACEMENT' => 'CRM_DETAIL_SEARCH',
                'HANDLER' => 'https://your-domain.com/widgets/crm-detail-search-handler.php',
                'TITLE' => 'Registry search',
                'LANG_ALL' => [
                    'en' => [
                        'TITLE' => 'Registry search',
                    ],
                    'de' => [
                        'TITLE' => 'Registersuche',
                    ],
                ],
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        
// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "placement.bind", b24.Params{
        	"PLACEMENT": "CRM_DETAIL_SEARCH",
        	"HANDLER":   "https://your-domain.com/widgets/crm-detail-search-handler.php",
        	"TITLE":     "Registry search",
        	"LANG_ALL": b24.Params{
        		"ru": b24.Params{
        			"TITLE": "Registry search",
        		},
        		"en": b24.Params{
        			"TITLE": "Registry search",
        		},
        	},
        })
        if err != nil {
        	return fmt.Errorf("placement.bind: %w", err)
        }
        
        // The response arrives as json.RawMessage — unmarshal it
        // into a struct matching the response shape shown below on this page.
        fmt.Printf("%s\n", res.Result)
        

Continue Learning