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

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

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

Scope: crm

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

Метод crm.userfield.fields возвращает описание характеристик пользовательского поля CRM: тип значения каждой характеристики и признаки того, задается ли она при создании и меняется ли позже.

По этому описанию собирают fields для методов crm.*.userfield.add и crm.*.userfield.update, например crm.deal.userfield.add. Какой метод создает поле нужного типа, указано в разделе Как выбрать раздел.

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

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

Примеры кода

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

cURL (Webhook)

cURL (OAuth)

JS (TS)

JS (UMD)

Python

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

// 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 FieldDescriptor = {
  type: string
  title: string
  isReadOnly?: boolean
  isImmutable?: boolean
  isMultiple?: boolean
}

// Shape of the payload returned in result (match the "response handling" section of the page)
type UserfieldFieldsResult = Record<string, FieldDescriptor>

try {
  const response = await $b24.actions.v2.call.make<UserfieldFieldsResult>({
    method: 'crm.userfield.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(Object.keys(result))
  }
} 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 fetchUserfieldFields() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'crm.userfield.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(Object.keys(result))
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', fetchUserfieldFields)
</script>

from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.crm.userfield.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.fields',
            []
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    print_r($result);
} catch (Throwable $e) {
    echo $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>';

// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.userfield.fields", nil, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("crm.userfield.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
        },
        "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

Ключ объекта result — код характеристики пользовательского поля, значение — описание характеристики (подробное описание). В таблице указан тип значения, которое характеристика принимает в crm.*.userfield.*.

Название `тип`	Описание
ID `integer`	Идентификатор поля. Только для чтения
ENTITY_ID `string`	Код объекта CRM, к которому привязано поле, например `CRM_DEAL`. Метод `crm.*.userfield.add` подставляет код по объекту из имени метода, передавать его не нужно
FIELD_NAME `string`	Код поля в формате `UF_CRM_*`. Обязателен при создании. Код приводится к верхнему регистру, недостающий префикс `UF_CRM_` добавляется: `PRIORITY` станет `UF_CRM_PRIORITY`. Изменить код нельзя
USER_TYPE_ID `string`	Тип данных поля из ответа crm.userfield.types. Задается при создании, изменить нельзя
XML_ID `string`	Внешний идентификатор
SORT `integer`	Порядок сортировки
MULTIPLE `char`	Признак множественного поля: `Y` или `N`, по умолчанию `N`. Задается при создании, в `update` не меняется
MANDATORY `char`	Признак обязательного поля: `Y` или `N`
SHOW_FILTER `char`	Признак отображения в фильтре списка. При записи передавайте `Y` или `N`. В ответе `crm..userfield.get` и `crm..userfield.list` вместо `Y` приходит `E` — поиск по маске. У полей типа `employee` приходит `I` — точное совпадение
SHOW_IN_LIST `char`	Признак отображения в списке: `Y` или `N`
EDIT_IN_LIST `char`	Разрешено ли пользователю редактировать значение: `Y` или `N`
IS_SEARCHABLE `char`	Участвуют ли значения поля в поиске: `Y` или `N`
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`. Описание полей элемента возвращает метод crm.userfield.enumeration.fields
SETTINGS `object`	Настройки, которые зависят от типа поля. Состав для каждого типа возвращает метод crm.userfield.settings.fields

Описание характеристики

Название `тип`	Описание
type `string`	Тип значения: `int`, `string`, `char`, `object` или `uf_enum_element`
title `string`	Название характеристики на языке интерфейса Битрикс24
isReadOnly `boolean`	Значение задает система, передать его нельзя. Ключ есть только у `ID`
isImmutable `boolean`	Значение задается при создании поля и не меняется в `update`. Ключ есть у `ENTITY_ID`, `FIELD_NAME`, `USER_TYPE_ID`
isMultiple `boolean`	Значение передается массивом. Ключ есть только у `LIST`

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

Собственных ошибок у метода нет: он не проверяет права в CRM и не принимает параметров.

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

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

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус	Код Текст ошибки	Описание
`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	Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит
`401`	`NO_AUTH_FOUND` Wrong authorization data	В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука
`401`	`INVALID_REQUEST` Https required	Методы вызываются только по протоколу HTTPS
`401`	`OVERLOAD_LIMIT` REST API is blocked due to overload	REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24
`401`	`ACCESS_DENIED` REST is available only on commercial plans	REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — `REST is available only by subscription`
`401`	`INVALID_CREDENTIALS` Invalid request credentials	Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом
`404`	`ERROR_METHOD_NOT_FOUND` Method not found!	Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа
`401`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на `provided by the access token`
`401`	`expired_token` The access token provided has expired	Срок действия access-токена истек
`401`	`user_access_error` The user does not have access to the application	Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям
`403`	`PORTAL_DELETED` Portal was deleted	Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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

Была ли статья полезна?

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

Получить описание полей настроек

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

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

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

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

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

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

Описание характеристикиОписание характеристики

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

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

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