Получить поля контакта crm.contact.fields

Если вы разрабатываете интеграции для Битрикс24 с помощью AI-инструментов (Codex, Claude Code, Cursor), подключите MCP-сервер, чтобы ассистент использовал официальную REST-документацию.

Scope: crm

Кто может выполнять метод: любой пользователь

DEPRECATED

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

Метод возвращает описание полей контакта, в том числе пользовательских.

Без параметров.

Примеры кода

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

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

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.contact.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.contact.fields

try
        {
        	const response = await $b24.callMethod(
        		'crm.contact.fields',
        		{}
        	);
        	
        	const result = response.getData().result;
        	console.info('Поля контакта', result);
        }
        catch( error )
        {
        	console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.contact.fields',
                    []
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                error_log($result->error());
                echo 'Error: ' . $result->error();
            } else {
                echo 'Поля контакта: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error fetching contact fields: ' . $e->getMessage();
        }

BX24.callMethod(
            "crm.contact.fields",
            {},
            (result) => {
                if(result.error())
                    console.error(result.error());
                else
                    console.info("Поля контакта", result.data());
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.contact.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"
                },
                "HONORIFIC": {
                "type": "crm_status",
                "isRequired": false,
                "isReadOnly": false,
                "isImmutable": false,
                "isMultiple": false,
                "isDynamic": false,
                "statusType": "HONORIFIC",
                "title": "Обращение"
                },
                "NAME": {
                "type": "string",
                "isRequired": true,
                "isReadOnly": false,
                "isImmutable": false,
                "isMultiple": false,
                "isDynamic": false,
                "title": "Имя"
                },
                "SECOND_NAME": {
                "type": "string",
                "isRequired": true,
                "isReadOnly": false,
                "isImmutable": false,
                "isMultiple": false,
                "isDynamic": false,
                "title": "Отчество"
                },
                "LAST_NAME": {
                "type": "string",
                "isRequired": true,
                "isReadOnly": false,
                "isImmutable": false,
                "isMultiple": false,
                "isDynamic": false,
                "title": "Фамилия"
                },
                "PHOTO": {
                "type": "file",
                "isRequired": false,
                "isReadOnly": false,
                "isImmutable": false,
                "isMultiple": false,
                "isDynamic": false,
                "title": "Фотография"
                },
                "BIRTHDATE": {
                "type": "date",
                "isRequired": false,
                "isReadOnly": false,
                "isImmutable": false,
                "isMultiple": false,
                "isDynamic": false,
                "title": "Дата рождения"
                },
                "TYPE_ID": {
                "type": "crm_status",
                "isRequired": false,
                "isReadOnly": false,
                "isImmutable": false,
                "isMultiple": false,
                "isDynamic": false,
                "statusType": "CONTACT_TYPE",
                "title": "Тип контакта"
                },
                "SOURCE_ID": {
                "type": "crm_status",
                "isRequired": false,
                "isReadOnly": false,
                "isImmutable": false,
                "isMultiple": false,
                "isDynamic": false,
                "statusType": "SOURCE",
                "title": "Источник"
                },
                "SOURCE_DESCRIPTION": {
                "type": "string",
                "isRequired": false,
                "isReadOnly": false,
                "isImmutable": false,
                "isMultiple": false,
                "isDynamic": false,
                "title": "Дополнительно об источнике"
                },
                "POST": {
                "type": "string",
                "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": "Идентификатор адреса местоположения"
                },
                "COMMENTS": {
                "type": "string",
                "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": "Доступен для всех"
                },
                "EXPORT": {
                "type": "char",
                "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": "Задана открытая линия"
                },
                "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": "Дата изменения"
                },
                "COMPANY_ID": {
                "type": "crm_company",
                "isRequired": false,
                "isReadOnly": false,
                "isImmutable": false,
                "isMultiple": false,
                "isDynamic": false,
                "isDeprecated": true,
                "title": "Компания"
                },
                "COMPANY_IDS": {
                "type": "crm_company",
                "isRequired": false,
                "isReadOnly": false,
                "isImmutable": false,
                "isMultiple": true,
                "isDynamic": false,
                "title": "COMPANY_IDS"
                },
                "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": "Условие поиска кампании"
                },
                "LAST_ACTIVITY_TIME": {
                "type": "datetime",
                "isRequired": false,
                "isReadOnly": true,
                "isImmutable": false,
                "isMultiple": false,
                "isDynamic": false,
                "title": "Последняя активность"
                },
                "LAST_ACTIVITY_BY": {
                "type": "user",
                "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"
                }
            },
            "time": {
                "start": 1715004755.782705,
                "finish": 1715004756.118899,
                "duration": 0.3361940383911133,
                "processing": 0.10344505310058594,
                "date_start": "2024-05-06T17:12:35+03:00",
                "date_finish": "2024-05-06T17:12:36+03:00",
                "operating": 0
            }
        }

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

Название `тип`	Описание
ID `integer`	Идентификатор контакта. Только для чтения
HONORIFIC `crm_status`	Обращение. Получить значения справочника можно с помощью метода crm.status.list с фильтром по `ENTITY_ID=HONORIFIC`
NAME `string`	Имя
SECOND_NAME `string`	Отчество
LAST_NAME `string`	Фамилия
PHOTO `file`	Фотография
BIRTHDATE `date`	Дата рождения
TYPE_ID `crm_status`	Тип контакта. Получить значения справочника можно с помощью метода crm.status.list с фильтром по `ENTITY_ID=CONTACT_TYPE`
SOURCE_ID `crm_status`	Источник. Получить значения справочника можно с помощью метода crm.status.list с фильтром по `ENTITY_ID=SOURCE`
SOURCE_DESCRIPTION `string`	Дополнительно об источнике
POST `string`	Должность
COMMENTS `string`	Комментарий. Поддерживает bb-коды
OPENED `char`	Доступен ли для всех. Возможные значения: `Y` — да `N` — нет Учитывается в работе прав доступа для ролей с уровнем доступа «Все открытые»
EXPORT `char`	Участвует в экспорте контактов. Возможные значения: `Y` — да `N` — нет
HAS_PHONE `char`	Задан ли телефон. Возможные значения: `Y` — да `N` — нет Только для чтения
HAS_EMAIL `char`	Задан ли e-mail. Возможные значения: `Y` — да `N` — нет Только для чтения
HAS_IMOL `char`	Задана открытая линия. Возможные значения: `Y` — да `N` — нет Только для чтения
ASSIGNED_BY_ID `user`	Ответственный
CREATED_BY_ID `user`	Кем создан. Только для чтения
MODIFY_BY_ID `user`	Кем изменен. Только для чтения
DATE_CREATE `datetime`	Дата создания. Только для чтения
DATE_MODIFY `datetime`	Дата изменения. Только для чтения
COMPANY_ID `crm_company`	Основная компания контакта
COMPANY_IDS `crm_company`	Привязка контакта к компаниям. Множественное. В методах `crm.contact.update` и `crm.contact.add` используется для подачи массива компаний. В методах `crm.contact.list` и `crm.contact.get` поля нет и необходимо использовать `crm.contact.company.items.get` для получения списка компаний
LEAD_ID `crm_lead`	Идентификатор лида, связанного с контактом. Только для чтения
UTM_SOURCE `string`	Рекламная система (Yandex-Direct, Google-Adwords и другие)
UTM_MEDIUM `string`	Тип трафика. Возможные значения: `CPC` — объявления `CPM` — баннеры
UTM_CAMPAIGN `string`	Обозначение рекламной кампании
UTM_CONTENT `string`	Содержание кампании. Например, для контекстных объявлений
UTM_TERM `string`	Условие поиска кампании. Например, ключевые слова контекстной рекламы
LAST_ACTIVITY_TIME `datetime`	Дата последней активности в таймлайне. Только для чтения
LAST_ACTIVITY_BY `user`	Автор последней активности в таймлайне. Только для чтения
PHONE `crm_multifield`	Телефоны. Множественное
EMAIL `crm_multifield`	E-mail. Множественное
WEB `crm_multifield`	Сайты. Множественное
IM `crm_multifield`	Мессенджеры. Множественное
LINK `crm_multifield`	Ссылки. Множественное. Служебное.
UF_...	Пользовательские поля. Например, `UF_CRM_25534736`. В зависимости от настроек портала у контактов может быть набор пользовательских полей определенных типов. Добавить пользовательское поле в контакт можно с помощью метода crm.contact.userfield.add
PARENT_ID_...	Поля связей. Если на портале есть смарт-процессы, связанные с контактами, для каждого такого смарт-процесса существует поле, хранящее связь между этим смарт-процессом и контактом. Само поле хранит идентификатор элемента такого смарт-процесса. Например, поле `PARENT_ID_153` — связь со смарт-процессом `entityTypeId=153`. Оно хранит идентификатор элемента этого смарт-процесса, связанного с текущим контактом

Поля связи с внешними источниками данных

Если контакт создан внешней системой, то:

поле ORIGINATOR_ID хранит строковый идентификатор этой системы
поле ORIGIN_ID хранит строковый идентификатор контакта в этой внешней системе
поле ORIGIN_VERSION хранит версию данных контакта в этой внешней системе

Название `тип`	Описание
ORIGINATOR_ID `string`	Идентификатор внешней системы, являющейся источником данных об этом контакте
ORIGIN_ID `string`	Идентификатор контакта во внешней системе
ORIGIN_VERSION `string`	Версия данных о контакте во внешней системе. Используется для защиты данных от случайного перетирания внешней системой. Если данные были импортированы и не изменялись во внешней системе, то такие данные могут быть отредактированы в CRM без опасения, что следующая выгрузка приведет к перетиранию данных

Устаревшие поля

Поля адреса в контакте являются устаревшими и используются только в режиме совместимости. Для работы с адресом используйте реквизиты.

Название `тип`	Описание
ADDRESS `string`	Адрес
ADDRESS_2 `string`	Вторая строка адреса
ADDRESS_CITY `string`	Город
ADDRESS_POSTAL_CODE `string`	Почтовый индекс
ADDRESS_REGION `string`	Район
ADDRESS_PROVINCE `string`	Область
ADDRESS_COUNTRY `string`	Страна
ADDRESS_COUNTRY_CODE `string`	Код страны
ADDRESS_LOC_ADDR_ID `location`	Идентификатор адреса местоположения

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

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

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.contact.fields

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

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

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

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

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

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