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

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

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

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

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

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

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

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

Название
тип

Описание

moduleId*
string

Идентификатор модуля, в котором находится поле

id*
integer

Идентификатор настроек пользовательского поля.

Идентификатор можно получить методом 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
// 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

// Shape of the payload returned in result (match the "response handling" section of the page)
type UserfieldconfigGetResult = {
  field: {
    id: string
    entityId: string
    fieldName: string
    userTypeId: string
    xmlId: string | null
    sort: string
    multiple: string
    mandatory: string
    showFilter: string
    showInList: string
    editInList: string
    isSearchable: string
    settings: Record<string, unknown>
    languageId: Record<string, string>
    editFormLabel: Record<string, string | null>
    listColumnLabel: Record<string, string | null>
    listFilterLabel: Record<string, string | null>
    errorMessage: Record<string, string | null>
    helpMessage: Record<string, string | null>
    enum?: Array<{
      id: string
      userFieldId: string
      value: string
      def: string
      sort: string
      xmlId: string
    }>
  } | null
}

try {
  const response = await $b24.actions.v2.call.make<UserfieldconfigGetResult>({
    method: 'userfieldconfig.get',
    params: {
      moduleId: 'crm',
      id: 7095,
    },
    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(result.field?.id, result.field?.fieldName, result.field?.userTypeId)
  }
} 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 getUserfieldConfig() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'userfieldconfig.get',
        params: {
          moduleId: 'crm',
          id: 7095,
        },
        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(result.field?.id, result.field?.fieldName, result.field?.userTypeId)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', getUserfieldConfig)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.userfieldconfig.get(
        module_id="crm",
        bitrix_id=7095,
    ).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(
            '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>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "userfieldconfig.get", b24.Params{
	"moduleId": "crm",
	"id":       7095,
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("userfieldconfig.get: %w", err)
}

// Метод заворачивает ответ в объект с ключом "field".
raw, ok := b24.Unwrap(res.Result, "field")
if !ok {
	return fmt.Errorf("в ответе нет ключа field")
}

var item struct {
	ID         b24.ID `json:"id"`
	EntityID   string `json:"entityId"`
	FieldName  string `json:"fieldName"`
	UserTypeID string `json:"userTypeId"`
	Sort       string `json:"sort"`
	Multiple   string `json:"multiple"`
}
if err := json.Unmarshal(raw, &item); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.ID, item.EntityID)

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

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
object

Корневой элемент ответа. Если поле не найдено, может вернуться null

time
time

Информация о времени выполнения запроса

Объект result

Название
тип

Описание

field
object

Настройки пользовательского поля (подробное описание)

Объект field

Название
тип

Описание

id
integer

Идентификатор настроек поля

entityId
string

Идентификатор объекта

fieldName
string

Код поля

userTypeId
string

Идентификатор типа поля

xmlId
string

Внешний идентификатор поля

sort
integer

Индекс сортировки

multiple
boolean

Флаг множественного значения (Y/N)

mandatory
boolean

Флаг обязательного поля (Y/N)

showFilter
boolean

Флаг показа поля в фильтре

showInList
boolean

Флаг показа поля в списке

editInList
boolean

Флаг редактирования в списке

isSearchable
boolean

Флаг участия в поиске

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
string

Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки

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

Код

Описание

Значение

Пустое значение

Вы не можете просматривать настройки пользовательских полей

Недостаточно прав на просмотр поля. Эта же ошибка может возвращаться, если поле с переданным id уже удалено или недоступно в контексте moduleId

Пустое значение

The current method required more scopes. (crm)

У приложения нет нужного scope для модуля из moduleId

Пустое значение

No settings for UserFieldAccess

Для переданного moduleId не настроен доступ к пользовательским полям

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

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

Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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