Получить описание полей компании crm.company.fields
Если вы разрабатываете интеграции для Битрикс24 с помощью AI-инструментов (Codex, Claude Code, Cursor), подключите MCP-сервер, чтобы ассистент использовал официальную REST-документацию.
Scope:
crmКто может выполнять метод: любой пользователь
DEPRECATED
Развитие метода остановлено. Используйте crm.item.fields.
Метод crm.company.fields возвращает описание полей компании, в том числе пользовательских.
Параметры метода
Без параметров.
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.company.fields
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.company.fields
try
{
const response = await $b24.callMethod(
'crm.company.fields',
{}
);
const result = response.getData().result;
if(result.error())
{
console.error(result.error());
}
else
{
console.dir(result);
}
}
catch(error)
{
console.error('Error:', error);
}
try {
$response = $b24Service
->core
->call(
'crm.company.fields',
[]
);
$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 fetching company fields: ' . $e->getMessage();
}
BX24.callMethod(
"crm.company.fields",
{},
function(result)
{
if(result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'crm.company.fields',
[]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Обработка ответа
HTTP-статус: 200
{
"result": {
"ID": {
"type": "integer",
"isRequired": false,
"isReadOnly": true,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "ID"
},
"TITLE": {
"type": "string",
"isRequired": true,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Название компании"
},
"COMPANY_TYPE": {
"type": "crm_status",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"statusType": "COMPANY_TYPE",
"title": "Тип компании"
},
"LOGO": {
"type": "file",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Логотип"
},
"ADDRESS": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Фактический адрес"
},
"ADDRESS_2": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Адрес (стр. 2)"
},
"ADDRESS_CITY": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Город"
},
"ADDRESS_POSTAL_CODE": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Почтовый индекс"
},
"ADDRESS_REGION": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Район"
},
"ADDRESS_PROVINCE": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Область"
},
"ADDRESS_COUNTRY": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Страна"
},
"ADDRESS_COUNTRY_CODE": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Код страны"
},
"ADDRESS_LOC_ADDR_ID": {
"type": "integer",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Идентификатор адреса местоположения"
},
"ADDRESS_LEGAL": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Юридический адрес"
},
"REG_ADDRESS": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Юридический адрес"
},
"REG_ADDRESS_2": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Юридический адрес (стр. 2)"
},
"REG_ADDRESS_CITY": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Юридический адрес город"
},
"REG_ADDRESS_POSTAL_CODE": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Юридический адрес почтовый индекс "
},
"REG_ADDRESS_REGION": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Юридический адрес район"
},
"REG_ADDRESS_PROVINCE": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Юридический адрес область"
},
"REG_ADDRESS_COUNTRY": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Юридический адрес страна"
},
"REG_ADDRESS_COUNTRY_CODE": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Юридический адрес код страны"
},
"REG_ADDRESS_LOC_ADDR_ID": {
"type": "integer",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Юридический адрес идентификатор адреса местоположения"
},
"BANKING_DETAILS": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Банковские реквизиты"
},
"INDUSTRY": {
"type": "crm_status",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"statusType": "INDUSTRY",
"title": "Сфера деятельности"
},
"EMPLOYEES": {
"type": "crm_status",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"statusType": "EMPLOYEES",
"title": "Кол-во сотрудников"
},
"CURRENCY_ID": {
"type": "crm_currency",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Валюта"
},
"REVENUE": {
"type": "double",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Годовой оборот"
},
"OPENED": {
"type": "char",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Доступна для всех"
},
"COMMENTS": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Комментарий"
},
"HAS_PHONE": {
"type": "char",
"isRequired": false,
"isReadOnly": true,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Задан телефон"
},
"HAS_EMAIL": {
"type": "char",
"isRequired": false,
"isReadOnly": true,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Задан e-mail"
},
"HAS_IMOL": {
"type": "char",
"isRequired": false,
"isReadOnly": true,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Задана открытая линия"
},
"IS_MY_COMPANY": {
"type": "char",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Моя компания"
},
"ASSIGNED_BY_ID": {
"type": "user",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Ответственный"
},
"CREATED_BY_ID": {
"type": "user",
"isRequired": false,
"isReadOnly": true,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Кем создана"
},
"MODIFY_BY_ID": {
"type": "user",
"isRequired": false,
"isReadOnly": true,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Кем изменена"
},
"DATE_CREATE": {
"type": "datetime",
"isRequired": false,
"isReadOnly": true,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Дата создания"
},
"DATE_MODIFY": {
"type": "datetime",
"isRequired": false,
"isReadOnly": true,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Дата изменения"
},
"CONTACT_ID": {
"type": "crm_contact",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": true,
"isDynamic": false,
"title": "Контакт"
},
"LEAD_ID": {
"type": "crm_lead",
"isRequired": false,
"isReadOnly": true,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Лид",
"settings": {
"parentEntityTypeId": 1
}
},
"ORIGINATOR_ID": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Внешний источник"
},
"ORIGIN_ID": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Идентификатор элемента во внешнем источнике"
},
"ORIGIN_VERSION": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Версия оригинала"
},
"UTM_SOURCE": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Рекламная система"
},
"UTM_MEDIUM": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Тип трафика"
},
"UTM_CAMPAIGN": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Обозначение рекламной кампании"
},
"UTM_CONTENT": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Содержание кампании"
},
"UTM_TERM": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Условие поиска кампании"
},
"PARENT_ID_156": {
"type": "crm_entity",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Закупка",
"settings": {
"parentEntityTypeId": 156
}
},
"LAST_ACTIVITY_TIME": {
"type": "datetime",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Последняя активность"
},
"LAST_ACTIVITY_BY": {
"type": "user",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Автор последней активности в таймлайне"
},
"LAST_COMMUNICATION_TIME": {
"type": "string",
"isRequired": false,
"isReadOnly": true,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Дата последней коммуникации"
},
"PHONE": {
"type": "crm_multifield",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": true,
"isDynamic": false,
"title": "Телефон"
},
"EMAIL": {
"type": "crm_multifield",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": true,
"isDynamic": false,
"title": "E-mail"
},
"WEB": {
"type": "crm_multifield",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": true,
"isDynamic": false,
"title": "Сайт"
},
"IM": {
"type": "crm_multifield",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": true,
"isDynamic": false,
"title": "Мессенджер"
},
"LINK": {
"type": "crm_multifield",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": true,
"isDynamic": false,
"title": "LINK"
},
"UF_CRM_1687188367": {
"type": "crm",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": true,
"title": "UF_CRM_1687188367",
"listLabel": "Дочерняя компания",
"formLabel": "Дочерняя компания",
"filterLabel": "Дочерняя компания",
"settings": {
"COMPANY": "Y",
"LEAD": null
}
},
"UF_CRM_64A29A1CD5CC2": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": true,
"title": "UF_CRM_64A29A1CD5CC2",
"listLabel": "Новое поле",
"formLabel": "Новое поле",
"filterLabel": "Новое поле",
"settings": {
"SIZE": 20,
"ROWS": 1,
"REGEXP": "",
"MIN_LENGTH": 0,
"MAX_LENGTH": 0,
"DEFAULT_VALUE": ""
}
}
},
"time": {
"start": 1769494687,
"finish": 1769494687.641697,
"duration": 0.6416969299316406,
"processing": 0,
"date_start": "2026-01-27T09:18:07+03:00",
"date_finish": "2026-01-27T09:18:07+03:00",
"operating_reset_at": 1769495287,
"operating": 0
}
}
Возвращаемые данные
|
Название |
Описание |
|
ID |
Идентификатор компании |
|
TITLE |
Название компании |
|
COMPANY_TYPE |
Тип компании. Значения можно получить методом crm.status.list с фильтром по |
|
LOGO |
Логотип |
|
ADDRESS |
Фактический адрес. Устарел, используется для совместимости. Для работы с адресом используйте реквизиты. Устаревшие адресные поля:
|
|
BANKING_DETAILS |
Банковские реквизиты |
|
INDUSTRY |
Сфера деятельности. Значения можно получить методом crm.status.list с фильтром по |
|
EMPLOYEES |
Количество сотрудников. Значения можно получить методом crm.status.list с фильтром по |
|
CURRENCY_ID |
Валюта |
|
REVENUE |
Годовой оборот |
|
OPENED |
Доступна ли компания для всех. Возможные значения: |
|
COMMENTS |
Комментарий |
|
HAS_PHONE |
Задан телефон |
|
HAS_EMAIL |
Задан e-mail |
|
HAS_IMOL |
Задана открытая линия |
|
IS_MY_COMPANY |
Признак «Моя компания». Возможные значения: |
|
ASSIGNED_BY_ID |
Ответственный |
|
CREATED_BY_ID |
Кем создана |
|
MODIFY_BY_ID |
Кем изменена |
|
DATE_CREATE |
Дата создания |
|
DATE_MODIFY |
Дата изменения |
|
CONTACT_ID |
Контакт. Множественное |
|
LEAD_ID |
Идентификатор лида, связанного с компанией |
|
ORIGINATOR_ID |
Идентификатор источника данных. Используется только для привязки к внешнему источнику |
|
ORIGIN_ID |
Идентификатор элемента в источнике данных. Используется только для привязки к внешнему источнику |
|
ORIGIN_VERSION |
Оригинальная версия. Используется для защиты данных от случайного перетирания внешней системой |
|
UTM_SOURCE |
Рекламная система. Yandex-Direct, Google-Adwords и другие |
|
UTM_MEDIUM |
Тип трафика. Возможные значения:
|
|
UTM_CAMPAIGN |
Обозначение рекламной кампании |
|
UTM_CONTENT |
Содержание кампании. Например, для контекстных объявлений |
|
UTM_TERM |
Условие поиска кампании. Например, ключевые слова контекстной рекламы |
|
PARENT_ID_... |
Поля связей. Если на портале есть смарт-процессы, связанные с компаниями, для каждого такого смарт-процесса существует поле, хранящее связь между этим смарт-процессом и компанией. Само поле хранит идентификатор элемента такого смарт-процесса |
|
LAST_ACTIVITY_TIME |
Последняя активность |
|
LAST_ACTIVITY_BY |
Автор последней активности в таймлайне |
|
LAST_COMMUNICATION_TIME |
Дата последней коммуникации |
|
PHONE |
Телефон. Множественное |
|
EMAIL |
E-mail. Множественное |
|
WEB |
Сайт. Множественное |
|
Мессенджер. Множественное |
|
|
LINK |
LINK. Множественное |
|
UF_... |
Пользовательские поля. Например, В зависимости от настроек портала у компаний может быть набор пользовательских полей определенных типов. Добавить пользовательское поле в компанию можно с помощью метода crm.company.userfield.add |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error": "",
"error_description": "Access denied."
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
Значение |
|
|
|
У пользователя нет прав на «Чтение» компаний |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Создать новую компанию crm.company.add
- Получить информацию о компании crm.company.get
- Получить список компаний по фильтру crm.company.list
- Обновить существующую компанию crm.company.update
- Удалить компанию crm.company.delete