Получить список настроек пользовательских полей userfieldconfig.list

Выберите инструмент для разработки с AI-агентом:

используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: userfieldconfig, scope модуля из moduleId (например, crm)

Кто может выполнять метод: пользователь с правом чтения объекта, которому принадлежат поля, в модуле moduleId

Метод userfieldconfig.list возвращает список настроек пользовательских полей по фильтру.

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

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

Название `тип`	Описание
moduleId* `string`	Идентификатор модуля, в котором выполняется поиск полей
select `object`	Набор полей, которые нужно вернуть (подробное описание)
order `object`	Объект формата: `{ field_1: value_1, field_2: value_2, ..., field_n: value_n, }` `field_n` - название поля, по которому будет произведена сортировка выборки `value_n` - значение типа `string`, равное: `ASC` - сортировка по возрастанию `DESC` - сортировка по убыванию Список доступных полей для сортировки: `id` - идентификатор пользовательского поля `fieldName` - код пользовательского поля `userTypeId` - тип пользовательского поля `xmlId` - внешний код `sort` - индекс сортировки По умолчанию: `{ "sort": "ASC", "id": "ASC" }`
filter `object`	Объект формата: `{ field_1: value_1, field_2: value_2, ..., field_n: value_n, }` `field_n` - название поля, по которому будет отфильтрована выборка пользовательских полей `value_n` - значение фильтра Все условия по отдельным полям соединяются с помощью `AND`. Смотрите ниже список доступных полей для фильтрации
start `integer`	Смещение для постраничной выборки. Используйте значение параметра `next` из предыдущего ответа

Параметр select

Название `тип`	Описание
* `string`	Вернуть все стандартные поля настройки
language `string`	Языковой идентификатор для языковых полей, например `ru` или `en`
id `string`	Идентификатор настройки поля
entityId `string`	Идентификатор объекта
fieldName `string`	Код поля
userTypeId `string`	Тип поля
xmlId `string`	Внешний идентификатор
sort `string`	Индекс сортировки
multiple `string`	Является ли пользовательское поле множественным. Возможные значения: `Y` или `N`
mandatory `string`	Является ли пользовательское поле обязательным. Возможные значения: `Y` или `N`
showFilter `string`	Показывать ли поле в фильтре списка. Возможные значения: `N`, `I`, `E`, `S`
showInList `string`	Показывать ли поле в списке. Возможные значения: `Y` или `N`
editInList `string`	Разрешать ли редактирование значения в списке. Возможные значения: `Y` или `N`
isSearchable `string`	Участвуют ли значения поля в поиске. Возможные значения: `Y` или `N`
settings `string`	Дополнительные настройки поля
languageId `string`	Языковой идентификатор. При передаче этого параметра возвращается набор языковых полей на выбранном языке: `editFormLabel` - подпись в форме редактирования `listColumnLabel` - заголовок в списке `listFilterLabel` - подпись фильтра в списке `errorMessage` - сообщение об ошибке `helpMessage` - помощь

Доступные для фильтрации поля

Название `тип`	Описание
id `integer`	Идентификатор пользовательского поля
fieldName `string`	Код пользовательского поля
userTypeId `string`	Тип пользовательского поля
xmlId `string`	Внешний код
sort `integer`	Индекс сортировки
multiple `boolean`	Является ли пользовательское поле множественным. Возможные значения: `Y` или `N`
mandatory `boolean`	Является ли пользовательское поле обязательным. Возможные значения: `Y` или `N`
showFilter `char`	Показывать ли в фильтре списка. Возможные значения: `N`, `I`, `E`, `S`
showInList `boolean`	Показывать ли в списке. Возможные значения: `Y` или `N`
editInList `boolean`	Разрешать ли редактирование пользователем. Возможные значения: `Y` или `N`
isSearchable `boolean`	Участвуют ли значения поля в поиске. Возможные значения: `Y` или `N`

Примеры кода

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

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"moduleId":"crm","select":{"0":"*","language":"ru"},"order":{"id":"DESC"},"filter":{"multiple":"Y"},"start":0}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/userfieldconfig.list

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"moduleId":"crm","select":{"0":"*","language":"ru"},"order":{"id":"DESC"},"filter":{"multiple":"Y"},"start":0,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/userfieldconfig.list

try
        {
        	const response = await $b24.callMethod(
        		'userfieldconfig.list',
        		{
        			moduleId: 'crm',
        			select: {
        				0: '*',
        				language: 'ru',
        			},
        			order: {
        				id: 'DESC',
        			},
        			filter: {
        				multiple: 'Y',
        			},
        			start: 0,
        		}
        	);
        
        	const result = response.getData().result;
        	console.info(result);
        }
        catch (error)
        {
        	console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'userfieldconfig.list',
                    [
                        'moduleId' => 'crm',
                        'select' => [
                            0 => '*',
                            'language' => 'ru',
                        ],
                        'order' => [
                            'id' => 'DESC',
                        ],
                        'filter' => [
                            'multiple' => 'Y',
                        ],
                        'start' => 0,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Result: ' . print_r($result, true);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error: ' . $e->getMessage();
        }

BX24.callMethod(
            'userfieldconfig.list',
            {
                moduleId: 'crm',
                select: {
                    0: '*',
                    language: 'ru',
                },
                order: {
                    id: 'DESC',
                },
                filter: {
                    multiple: 'Y',
                },
            },
            (result) => {
                if (result.error()) {
                    console.error(result.error());
                    return;
                }
        
                console.info(result.data());
        
                if (result.more()) {
                    result.next();
                }
            },
        );

require_once('crest.php');
        
        $result = CRest::call(
            'userfieldconfig.list',
            [
                'moduleId' => 'crm',
                'select' => [
                    0 => '*',
                    'language' => 'ru',
                ],
                'order' => [
                    'id' => 'DESC',
                ],
                'filter' => [
                    'multiple' => 'Y',
                ],
                'start' => 0,
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

HTTP-статус: 200

{
            "result": {
                "fields": [
                    {
                        "id": "7095",
                        "entityId": "CRM_7",
                        "fieldName": "UF_CRM_7_NEW_REST_LIST_2026",
                        "userTypeId": "enumeration",
                        "xmlId": null,
                        "sort": "100",
                        "multiple": "Y",
                        "mandatory": "N",
                        "showFilter": "N",
                        "showInList": "Y",
                        "editInList": "Y",
                        "isSearchable": "N",
                        "settings": {
                            "DISPLAY": "LIST",
                            "LIST_HEIGHT": 1,
                            "CAPTION_NO_VALUE": "",
                            "SHOW_NO_VALUE": "Y"
                        },
                        "languageId": {
                            "ru": "ru"
                        },
                        "editFormLabel": {
                            "ru": "Список характеристик"
                        },
                        "listColumnLabel": null,
                        "listFilterLabel": null,
                        "errorMessage": null,
                        "helpMessage": null
                    }
                ]
            },
            "next": 50,
            "total": 94,
            "time": {
                "start": 1724239307.903115,
                "finish": 1724239308.567422,
                "duration": 0.6643068790435791,
                "processing": 0.20090818405151367,
                "date_start": "2024-08-21T13:21:47+02:00",
                "date_finish": "2024-08-21T13:21:48+02:00",
                "operating": 0
            }
        }

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

Название `тип`	Описание
result `object`	Корневой элемент ответа (подробное описание)
total `integer`	Общее количество найденных настроек
next `integer`	Смещение следующей страницы. Поле возвращается, если количество найденных элементов больше 50
time `time`	Информация о времени выполнения запроса

Объект result

Название `тип`	Описание
fields `object[]`	Список найденных настроек пользовательских полей (подробное описание)

Объект fields[]

Название `тип`	Описание
id `integer`	Идентификатор пользовательского поля
entityId `string`	Идентификатор объекта, к которому относится пользовательское поле
fieldName `string`	Код пользовательского поля
userTypeId `string`	Тип пользовательского поля
xmlId `string`	Внешний код
sort `integer`	Индекс сортировки
multiple `boolean`	Является ли пользовательское поле множественным. Возможные значения: `Y` или `N`
mandatory `boolean`	Является ли пользовательское поле обязательным. Возможные значения: `Y` или `N`
showFilter `char`	Режим отображения в фильтре. Возможные значения: `N`, `I`, `E`, `S`
showInList `boolean`	Показывать ли поле в списке. Возможные значения: `Y` или `N`
editInList `boolean`	Разрешать ли редактирование значения в списке. Возможные значения: `Y` или `N`
isSearchable `boolean`	Участвуют ли значения поля в поиске. Возможные значения: `Y` или `N`
settings `object`	Дополнительные настройки поля. Состав ключей зависит от `userTypeId`
languageId `object`	Языковые идентификаторы, для которых заданы подписи
editFormLabel `lang_map`	Подписи в форме редактирования
listColumnLabel `lang_map`	Заголовок в списке
listFilterLabel `lang_map`	Подпись фильтра в списке
errorMessage `lang_map`	Сообщение об ошибке
helpMessage `lang_map`	Подсказка
enum `object[]`	Элементы списка для `userTypeId = enumeration`. Поле может отсутствовать для других типов

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

HTTP-статус: 400

{
            "error": "",
            "error_description": "Вы не можете просматривать настройки пользовательских полей"
        }

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

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

Код	Описание	Значение
`-`	Вы не можете просматривать настройки пользовательских полей	Недостаточно прав на чтение полей по переданному фильтру
`-`	The current method required more scopes. (crm)	У приложения нет нужного scope для модуля из `moduleId`
`-`	No settings for UserFieldAccess	Для переданного `moduleId` не настроен доступ к пользовательским полям

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

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	Превышен лимит на интенсивность запросов
`429`	`OPERATION_TIME_LIMIT` Method is blocked due to operation time limit	Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут
`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	Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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

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

Изменить значения пользовательского поля

Получить список настроек пользовательских полей userfieldconfig.list

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

Параметр selectПараметр select

Доступные для фильтрации поляДоступные для фильтрации поля

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

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

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

Объект resultОбъект result

Объект fields[]Объект fields[]

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

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

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

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