Получить описание полей для пользовательского поля типа enumeration (список) crm.userfield.enumeration.fields
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
crmКто может выполнять метод: любой пользователь
Метод crm.userfield.enumeration.fields возвращает описание полей элемента списка для пользовательского поля типа enumeration.
В таком формате элементы передают в ключе LIST методов crm.*.userfield.add и crm.*.userfield.update, например crm.deal.userfield.add, и получают в ответе crm.*.userfield.get и crm.*.userfield.list. Метод REST 3.0 crm.<тип>.field.custom.add не создает поля типа enumeration, для них используйте устаревшие методы crm.*.userfield.add или userfieldconfig.add.
Параметры метода
Без параметров.
Примеры кода
Как использовать примеры в документации
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.enumeration.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.enumeration.fields
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
type FieldInfo = {
type: string
title: string
isReadOnly?: boolean
}
// Shape of the payload returned in result (match the "response handling" section of the page)
type EnumerationFieldsResult = Record<string, FieldInfo>
try {
const response = await $b24.actions.v2.call.make<EnumerationFieldsResult>({
method: 'crm.userfield.enumeration.fields',
params: {},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Enumeration field names:', Object.keys(result))
console.info('ID field:', result['ID'])
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function getEnumerationFields() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'crm.userfield.enumeration.fields',
params: {},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Enumeration field names:', Object.keys(result))
console.info('ID field:', result['ID'])
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getEnumerationFields)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.userfield.enumeration.fields().response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
try {
$response = $b24Service
->core
->call(
'crm.userfield.enumeration.fields',
[]
);
$result = $response
->getResponseData()
->getResult();
print_r($result);
} catch (Throwable $e) {
echo $e->getMessage();
}
BX24.callMethod(
"crm.userfield.enumeration.fields",
{},
function(result)
{
if(result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'crm.userfield.enumeration.fields',
[]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.userfield.enumeration.fields", nil, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("crm.userfield.enumeration.fields: %w", err)
}
keys, ok := b24.Keys(res.Result)
if !ok {
return fmt.Errorf("ожидался объект в ответе")
}
fmt.Println("полей в ответе:", len(keys))
Обработка ответа
HTTP-статус: 200
{
"result": {
"ID": {
"type": "int",
"title": "Ид",
"isReadOnly": true
},
"SORT": {
"type": "int",
"title": "Сортировка"
},
"VALUE": {
"type": "string",
"title": "Значение"
},
"DEF": {
"type": "string",
"title": "Значение по умолчанию"
},
"DEL": {
"type": "string",
"title": "Флаг удаления элемента"
}
},
"time": {
"start": 1773992153,
"finish": 1773992153.048253,
"duration": 0.04825305938720703,
"processing": 0,
"date_start": "2026-03-20T10:35:53+03:00",
"date_finish": "2026-03-20T10:35:53+03:00",
"operating_reset_at": 1773992753,
"operating": 0
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Объект с описанием полей (подробное описание) |
|
time |
Информация о времени выполнения запроса |
Объект result
Ключ объекта result — поле элемента списка, значение — описание поля (подробное описание). В таблице указан тип значения, которое поле принимает в LIST. Сводное описание элемента — объект uf_enum_element.
|
Название |
Описание |
|
ID |
Идентификатор элемента. Задает система: при создании поля не передается. В |
|
SORT |
Порядок сортировки. Если не передан или меньше 1, элемент получает |
|
VALUE |
Текст элемента. Элементы с пустым |
|
DEF |
Признак значения по умолчанию: |
|
DEL |
Флаг удаления: |
Кроме этих полей, элемент списка принимает XML_ID — внешний идентификатор элемента. Метод его не описывает. В ответе XML_ID элемента есть у crm.*.userfield.list, у crm.*.userfield.get его нет.
Описание поля
|
Название |
Описание |
|
type |
Тип значения: |
|
title |
Название поля на языке интерфейса Битрикс24 |
|
isReadOnly |
Значение задает система. Ключ есть только у |
Обработка ошибок
Собственных ошибок у метода нет: он не проверяет права в CRM и не принимает параметров.
|
Название |
Описание |
|
error |
Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только |
|
error_description |
Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки |
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Получить список типов пользовательских полей crm.userfield.types
- Получить описание для пользовательских полей crm.userfield.fields
- Получить описание полей настроек для типа пользовательского поля crm.userfield.settings.fields
- Создать пользовательское поле для сделок crm.deal.userfield.add
- Пользовательские поля в CRM: обзор методов