Получить параметры карточки crm.company.details.configuration.get

Scope: crm

Кто может выполнять метод:

любой пользователь может получать свои и общие настройки,

пользователь с правом «Разрешить изменять настройки» в CRM может получать чужие настройки

DEPRECATED

Развитие метода остановлено. Используйте crm.item.details.configuration.get.

Метод crm.company.details.configuration.get получает настройки карточки компаний: читает личные настройки карточки указанного пользователя или общие настройки, заданные для всех пользователей.

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

scope
string

Область применения настроек.

Возможные значения:

P — личные настройки
C — общие настройки

По умолчанию — P

userId
user

Идентификатор пользователя, получить можно методом user.get.

Нужен только администратору при запросе чужих личных настроек. Если не указан, вернутся настройки текущего пользователя

Примеры кода

Как использовать примеры в документации

Получить личную конфигурацию карточки

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"scope":"P","userId":6}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.company.details.configuration.get

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"scope":"P","userId":6,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.company.details.configuration.get

try
        {
            const response = await $b24.callMethod(
                'crm.company.details.configuration.get',
                {
                    scope: 'P',
                    userId: 6,
                }
            );
            
            const result = response.getData().result;
            console.log('Data:', result);
            processResult(result);
        }
        catch( error )
        {
            console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.company.details.configuration.get',
                    [
                        'scope' => 'P',
                        'userId' => 6
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error: ' . $e->getMessage();
        }

 BX24.callMethod(
             'crm.company.details.configuration.get',
             {
                 scope: "P",
                 userId: 6,
             },
             (result) => {
                 result.error()
                     ? console.error(result.error())
                     : console.info(result.data())
                 ;
             },
         );

 require_once('crest.php');
        
         $result = CRest::call(
             'crm.company.details.configuration.get',
             [
                 'scope' => 'P',
                 'userId' => 6
             ]
         );
        
         echo '<PRE>';
         print_r($result);
         echo '</PRE>';

Получить общую конфигурацию карточки

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"scope":"C"}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.company.details.configuration.get

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"scope":"C","auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.company.details.configuration.get

try
        {
            const response = await $b24.callMethod(
                'crm.company.details.configuration.get',
                {
                    scope: 'C',
                }
            );
            
            const result = response.getData().result;
            console.log('Configuration details:', result);
            
            processResult(result);
        }
        catch( error )
        {
            console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.company.details.configuration.get',
                    [
                        'scope' => 'C'
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error fetching company details configuration: ' . $e->getMessage();
        }

BX24.callMethod(
            'crm.company.details.configuration.get',
            {
                scope: "C",
            },
            (result) => {
                result.error()
                    ? console.error(result.error())
                    : console.info(result.data())
                ;
            },
        );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.company.details.configuration.get',
            [
                'scope' => 'C'
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Обработка ответа

HTTP-статус: 200

{
            "result": [
                {
                    "name": "main",
                    "title": "О компании",
                    "type": "section",
                    "elements": [
                        {
                            "name": "TITLE",
                            "optionFlags": "0"
                        },
                        {
                            "name": "COMPANY_TYPE",
                            "optionFlags": "0"
                        },
                        {
                            "name": "INDUSTRY",
                            "optionFlags": "0"
                        },
                        {
                            "name": "REVENUE_WITH_CURRENCY",
                            "optionFlags": "0"
                        },
                        {
                            "name": "EMAIL",
                            "optionFlags": "0"
                        },
                        {
                            "name": "CONTACT",
                            "optionFlags": "0",
                            "options": {
                                "defaultCountry": "RU"
                            }
                        },
                        {
                            "name": "UF_CRM_1687188367",
                            "optionFlags": "1"
                        },
                        {
                            "name": "UF_CRM_1706178583916",
                            "optionFlags": "1"
                        },
                        {
                            "name": "COMMENTS",
                            "optionFlags": "1"
                        },
                        {
                            "name": "REQUISITES",
                            "optionFlags": "1"
                        },
                        {
                            "name": "PARENT_ID_164",
                            "optionFlags": "0"
                        },
                        {
                            "name": "LOGO",
                            "optionFlags": "1"
                        },
                        {
                            "name": "PHONE",
                            "optionFlags": "1",
                            "options": {
                                "defaultCountry": "RU"
                            }
                        },
                        {
                            "name": "ADDRESS",
                            "optionFlags": "1"
                        }
                    ]
                },
                {
                    "name": "additional",
                    "title": "Дополнительно",
                    "type": "section",
                    "elements": [
                        {
                            "name": "EMPLOYEES",
                            "optionFlags": "0"
                        },
                        {
                            "name": "ASSIGNED_BY_ID",
                            "optionFlags": "0"
                        },
                        {
                            "name": "UTM",
                            "optionFlags": "0"
                        },
                        {
                            "name": "TRACKING_SOURCE_ID",
                            "optionFlags": "0"
                        }
                    ]
                },
                {
                    "name": "user_pl047oti",
                    "title": "Новый раздел",
                    "type": "section",
                    "elements": [
                        {
                            "name": "UF_CRM_1689255858",
                            "optionFlags": "1"
                        }
                    ]
                }
            ],
            "time": {
                "start": 1769418250,
                "finish": 1769418250.874948,
                "duration": 0.8749480247497559,
                "processing": 0,
                "date_start": "2026-01-26T12:04:10+03:00",
                "date_finish": "2026-01-26T12:04:10+03:00",
                "operating_reset_at": 1769418850,
                "operating": 0
            }
        }

Возвращаемые данные

Название
тип

Описание

result
section[]

Корневой элемент ответа.

Содержит конфигурацию разделов детальной карточки компании.

Возвращает null в случае отсутствия конфигурации

time
time

Информация о времени выполнения запроса

section

Описывает отдельно взятый раздел с полями внутри карточки элемента

Название `тип`	Описание
name `string`	Уникальное название раздела, используемое для идентификации
title `string`	Название раздела
type `string`	Тип раздела
elements `section_element[]`	Список выводимых в карточку полей с дополнительными настройками

section_element

Конфигурация отдельно взятого поля внутри раздела

Название `тип`	Описание
name `string`	Идентификатор поля
optionFlags `boolean`	Показывать ли поле всегда. Возможные значения: `"1"` — да `"0"` — нет
options `object`	Дополнительные опции поля. Структура описана ниже

section_element.options

Название
тип

Поля, где доступна опция

Описание

defaultAddressType
integer

ADDRESS

Идентификатор типа адреса по умолчанию. Чтобы узнать возможные типы адресов, используйте crm.enum.addresstype

defaultCountry
string

PHONE
CLIENT
COMPANY
CONTACT
MYCOMPANY_ID

Код страны для формата телефонного номера по умолчанию — строка из двух латинских букв.

Например "RU"

Обработка ошибок

HTTP-статус: 400

{
            "error": "",
            "error_description": "Access denied."
        }

Название `тип`	Описание
error `string`	Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания
error_description `error_description`	Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Код	Описание	Значение
`-`	`Access denied`	У пользователя нет права «Разрешить изменять настройки» для получения чужих настроек

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус	Код Текст ошибки	Описание
`500`	`INTERNAL_SERVER_ERROR` Internal server error	Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	Превышен лимит на интенсивность запросов
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	Текущий метод не разрешен для вызова с помощью batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	Превышена максимальная длина параметров, переданных в метод batch
`401`	`NO_AUTH_FOUND` Wrong authorization data	Неверный access-токен или код вебхука
`400`	`INVALID_REQUEST` Https required	Для вызовов методов требуется использовать протокол HTTPS
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	REST API доступен только на коммерческих планах
`403`	`INVALID_CREDENTIALS` Invalid request credentials	У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	Манифест недоступен
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	Запрос требует более высоких привилегий, чем предоставляет токен вебхука
`401`	`expired_token` The access token provided has expired	Предоставленный access-токен доступа истек
`403`	`user_access_error` The user does not have access to the application	Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям
`500`	`PORTAL_DELETED` Portal was deleted	Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Обзор методов

Сбросить параметры карточки

Получить параметры карточки crm.company.details.configuration.get

Параметры методаПараметры метода

Примеры кодаПримеры кода

Обработка ответаОбработка ответа

Возвращаемые данныеВозвращаемые данные

sectionsection

section_elementsection_element

section_element.optionssection_element.options

Обработка ошибокОбработка ошибок

Возможные коды ошибокВозможные коды ошибок

Статусы и коды системных ошибокСтатусы и коды системных ошибок

Продолжите изучениеПродолжите изучение

Параметры метода

Примеры кода

Обработка ответа

Возвращаемые данные

section

section_element

section_element.options

Обработка ошибок

Возможные коды ошибок

Статусы и коды системных ошибок

Продолжите изучение