Получить настройки пользовательского поля userfieldconfig.get
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
userfieldconfig, scope модуля изmoduleId(например,crm)Кто может выполнять метод: пользователь с правом чтения объекта, которому принадлежит поле, в модуле
moduleId
Метод userfieldconfig.get возвращает настройки пользовательского поля по его идентификатору.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
moduleId* |
Идентификатор модуля, в котором находится поле |
|
id* |
Идентификатор настроек пользовательского поля. Идентификатор можно получить методом userfieldconfig.list или при создании поля методом userfieldconfig.add |
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"moduleId":"crm","id":7095}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/userfieldconfig.get
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"moduleId":"crm","id":7095,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/userfieldconfig.get
try
{
const response = await $b24.callMethod(
'userfieldconfig.get',
{
moduleId: 'crm',
id: 7095,
}
);
const result = response.getData().result;
console.info(result);
}
catch (error)
{
console.error(error);
}
try {
$response = $b24Service
->core
->call(
'userfieldconfig.get',
[
'moduleId' => 'crm',
'id' => 7095,
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Result: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error: ' . $e->getMessage();
}
BX24.callMethod(
'userfieldconfig.get',
{
moduleId: 'crm',
id: 7095,
},
(result) => {
result.error()
? console.error(result.error())
: console.info(result.data())
;
},
);
require_once('crest.php');
$result = CRest::call(
'userfieldconfig.get',
[
'moduleId' => 'crm',
'id' => 7095,
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Обработка ответа
HTTP-статус: 200
{
"result": {
"field": {
"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": {
"en": "en",
"ru": "ru"
},
"editFormLabel": {
"en": "List of characteristics",
"ru": "Список характеристик"
},
"listColumnLabel": {
"en": null,
"ru": null
},
"listFilterLabel": {
"en": null,
"ru": null
},
"errorMessage": {
"en": null,
"ru": null
},
"helpMessage": {
"en": null,
"ru": null
},
"enum": [
{
"id": "3671",
"userFieldId": "7095",
"value": "Характеристика 1",
"def": "N",
"sort": "100",
"xmlId": "38a8c98a5de02f8ccdca2244e5065ecd"
},
{
"id": "3673",
"userFieldId": "7095",
"value": "Характеристика 2",
"def": "Y",
"sort": "200",
"xmlId": "9520e17b39f3525b820b809914b52207"
}
]
}
},
"time": {
"start": 1774355752,
"finish": 1774355752.177393,
"duration": 0.17739295959472656,
"processing": 0,
"date_start": "2026-03-24T15:35:52+03:00",
"date_finish": "2026-03-24T15:35:52+03:00",
"operating_reset_at": 1774356352,
"operating": 0
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Корневой элемент ответа. Если поле не найдено, может вернуться |
|
time |
Информация о времени выполнения запроса |
Объект result
|
Название |
Описание |
|
field |
Настройки пользовательского поля (подробное описание) |
Объект field
|
Название |
Описание |
|
id |
Идентификатор настроек поля |
|
entityId |
Идентификатор объекта |
|
fieldName |
Код поля |
|
userTypeId |
Идентификатор типа поля |
|
xmlId |
Внешний идентификатор поля |
|
sort |
Индекс сортировки |
|
multiple |
Флаг множественного значения ( |
|
mandatory |
Флаг обязательного поля ( |
|
showFilter |
Флаг показа поля в фильтре |
|
showInList |
Флаг показа поля в списке |
|
editInList |
Флаг редактирования в списке |
|
isSearchable |
Флаг участия в поиске |
|
settings |
Дополнительные настройки поля. Состав ключей зависит от |
|
languageId |
Языки, для которых заданы подписи поля |
|
editFormLabel |
Подписи в форме редактирования |
|
listColumnLabel |
Подписи колонки в списке |
|
listFilterLabel |
Подписи в фильтре |
|
errorMessage |
Текст сообщения об ошибке |
|
helpMessage |
Подсказка по полю |
|
enum |
Варианты значений. Поле возвращается только для |
Обработка ошибок
HTTP-статус: 400
{
"error": "",
"error_description": "Вы не можете просматривать настройки пользовательских полей"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
Значение |
|
|
Вы не можете просматривать настройки пользовательских полей |
Недостаточно прав на просмотр поля. Эта же ошибка может возвращаться, если поле с переданным |
|
|
The current method required more scopes. (crm) |
У приложения нет нужного scope для модуля из |
|
|
No settings for UserFieldAccess |
Для переданного |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Добавить пользовательское поле userfieldconfig.add
- Обновить пользовательское поле userfieldconfig.update
- Получить список настроек пользовательских полей userfieldconfig.list
- Удалить пользовательское поле userfieldconfig.delete
- Получить доступные типы пользовательских полей userfieldconfig.getTypes