Получить описание для пользовательских полей crm.userfield.fields

Scope: crm

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

Метод crm.userfield.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.userfield.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.userfield.fields

try
        {
        	const response = await $b24.callMethod(
        		"crm.userfield.fields",
        		{}
        	);
        
        	const result = response.getData().result;
        	console.dir(result);
        }
        catch(error)
        {
        	console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.userfield.fields',
                    []
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                error_log($result->error());
                echo 'Error: ' . $result->error();
            } else {
                echo 'Success: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error fetching CRM userfield fields: ' . $e->getMessage();
        }

BX24.callMethod(
            "crm.userfield.fields",
            {},
            function(result)
            {
                if(result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.userfield.fields',
            []
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

HTTP-статус: 200

{
            "result": {
                "ID": {
                    "type": "int",
                    "title": "Ид",
                    "isReadOnly": true
                },
                "ENTITY_ID": {
                    "type": "string",
                    "title": "Объект",
                    "isImmutable": true
                },
                "FIELD_NAME": {
                    "type": "string",
                    "title": "Код",
                    "isImmutable": true
                },
                "USER_TYPE_ID": {
                    "type": "string",
                    "title": "Тип данных",
                    "isImmutable": true
                },
                "XML_ID": {
                    "type": "string",
                    "title": "Внешний Ид (XML ID)"
                },
                "SORT": {
                    "type": "int",
                    "title": "Сортировка"
                },
                "MULTIPLE": {
                    "type": "char",
                    "title": "Множественное"
                },
                "MANDATORY": {
                    "type": "char",
                    "title": "Обязательное"
                },
                "SHOW_FILTER": {
                    "type": "char",
                    "title": "Показывать в фильтре списка"
                },
                "SHOW_IN_LIST": {
                    "type": "char",
                    "title": "Показывать в списке"
                },
                "EDIT_IN_LIST": {
                    "type": "char",
                    "title": "Разрешать редактирование пользователем"
                },
                "IS_SEARCHABLE": {
                    "type": "char",
                    "title": "Значения поля участвуют в поиске"
                },
                "EDIT_FORM_LABEL": {
                    "type": "string",
                    "title": "Подпись в форме редактирования"
                },
                "LIST_COLUMN_LABEL": {
                    "type": "string",
                    "title": "Заголовок в списке"
                },
                "LIST_FILTER_LABEL": {
                    "type": "string",
                    "title": "Подпись фильтра в списке"
                },
                "ERROR_MESSAGE": {
                    "type": "string",
                    "title": "Сообщение об ошибке"
                },
                "HELP_MESSAGE": {
                    "type": "string",
                    "title": "Помощь"
                },
                "LIST": {
                    "type": "uf_enum_element",
                    "title": "Элементы списка",
                    "isMultiple": true
                },
                "SETTINGS": {
                    "type": "object",
                    "title": "Дополнительные настройки (зависят от типа)"
                }
            },
            "time": {
                "start": 1773992295,
                "finish": 1773992295.958088,
                "duration": 0.9580879211425781,
                "processing": 0,
                "date_start": "2026-03-20T10:38:15+03:00",
                "date_finish": "2026-03-20T10:38:15+03:00",
                "operating_reset_at": 1773992895,
                "operating": 0
            }
        }

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

Название `тип`	Описание
result `object`	Объект с описанием характеристик (подробное описание)
time `time`	Информация о времени выполнения запроса

Поля объекта result

Название `тип`	Описание
ID `integer`	Идентификатор
ENTITY_ID `string`	Объект пользовательского поля
FIELD_NAME `string`	Код поля
USER_TYPE_ID `string`	Тип данных пользовательского поля
XML_ID `string`	Внешний Ид (XML ID)
SORT `integer`	Порядок сортировки
MULTIPLE `char`	Признак множественности
MANDATORY `char`	Признак обязательности
SHOW_FILTER `char`	Признак отображения в фильтре списка
SHOW_IN_LIST `char`	Признак отображения в списке
EDIT_IN_LIST `char`	Разрешать редактирование пользователем
IS_SEARCHABLE `char`	Значения поля участвуют в поиске
EDIT_FORM_LABEL `string`\|`lang_map`	Подпись в форме редактирования
LIST_COLUMN_LABEL `string`\|`lang_map`	Заголовок в списке
LIST_FILTER_LABEL `string`\|`lang_map`	Подпись фильтра в списке
ERROR_MESSAGE `string`\|`lang_map`	Сообщение об ошибке
HELP_MESSAGE `string`\|`lang_map`	Помощь
LIST `uf_enum_element`	Элементы списка для поля типа `enumeration`
SETTINGS `object`	Дополнительные настройки в зависимости от типа поля

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

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

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

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

Получить список типов пользовательских полей

Получить описание для пользовательских полей crm.userfield.fields

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

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

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

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

Поля объекта resultПоля объекта result

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

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

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