Получить пользовательское поле предложений по ID crm.quote.userfield.get

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

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

Scope: crm

Кто может выполнять метод: пользователь с правом чтения предложений

DEPRECATED

Развитие метода остановлено. Используйте метод REST 3.0 crm.quote.field.custom.get.

Метод crm.quote.userfield.get возвращает описание пользовательского поля предложений по идентификатору: имя, тип, настройки и подписи на всех языках.

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

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

Название
тип

Описание

id*
integer

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

Идентификатор можно получить с помощью методов crm.quote.userfield.add или crm.quote.userfield.list

Примеры кода

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

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 '{"id":399}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.quote.userfield.get

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":399,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.quote.userfield.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 QuoteUserFieldGetResult = {
  ID: string
  ENTITY_ID: string
  FIELD_NAME: string
  USER_TYPE_ID: string
  XML_ID: string | null
  SORT: string
  MULTIPLE: string
  MANDATORY: string
  SHOW_FILTER: string
  SHOW_IN_LIST: string
  EDIT_IN_LIST: string
  IS_SEARCHABLE: string
  SETTINGS: {
    SIZE: number
    ROWS: number
    REGEXP: string
    MIN_LENGTH: number
    MAX_LENGTH: number
    DEFAULT_VALUE: string
  }
  EDIT_FORM_LABEL: Record<string, string>
  LIST_COLUMN_LABEL: Record<string, string>
  LIST_FILTER_LABEL: Record<string, string>
  ERROR_MESSAGE: Record<string, string>
  HELP_MESSAGE: Record<string, string>
}

try {
  const response = await $b24.actions.v2.call.make<QuoteUserFieldGetResult>({
    method: 'crm.quote.userfield.get',
    params: {
      id: 399,
    },
    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.ID, result.FIELD_NAME, result.USER_TYPE_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 getQuoteUserField() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

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

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

from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.crm.quote.userfield.get(bitrix_id=399).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.quote.userfield.get',
            [
                'id' => 399,
            ]
        );

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

    print_r($result);
} catch (Throwable $e) {
    echo $e->getMessage();
}

BX24.callMethod(
    'crm.quote.userfield.get',
    {
        id: 399,
    },
    (result) => {
        result.error()
            ? console.error(result.error())
            : console.info(result.data())
        ;
    },
);

require_once('crest.php');

$result = CRest::call(
    'crm.quote.userfield.get',
    [
        'id' => 399
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';

// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.quote.userfield.get", b24.Params{
	"id": 399,
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("crm.quote.userfield.get: %w", err)
}

var item struct {
	ID         b24.ID `json:"ID"`
	EntityID   string `json:"ENTITY_ID"`
	FieldName  string `json:"FIELD_NAME"`
	UserTypeID string `json:"USER_TYPE_ID"`
	Sort       string `json:"SORT"`
	Multiple   string `json:"MULTIPLE"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.ID, item.EntityID)

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

HTTP-статус: 200

{
    "result": {
        "ID": "399",
        "ENTITY_ID": "CRM_QUOTE",
        "FIELD_NAME": "UF_CRM_HELLO_WORLD",
        "USER_TYPE_ID": "string",
        "XML_ID": null,
        "SORT": "2000",
        "MULTIPLE": "Y",
        "MANDATORY": "N",
        "SHOW_FILTER": "N",
        "SHOW_IN_LIST": "Y",
        "EDIT_IN_LIST": "N",
        "IS_SEARCHABLE": "N",
        "SETTINGS": {
            "SIZE": 20,
            "ROWS": 10,
            "REGEXP": "",
            "MIN_LENGTH": 0,
            "MAX_LENGTH": 0,
            "DEFAULT_VALUE": "Привет, мир! Значение по умолчанию (изменено)"
        },
        "EDIT_FORM_LABEL": {
            "ar": "",
            "br": "",
            "de": "Hallo, Welt! Bearbeiten (geändert)",
            "en": "Hello, World! Edit (changed)",
            "fr": "",
            "hi": "",
            "id": "",
            "in": "",
            "it": "",
            "ja": "",
            "kz": "",
            "la": "",
            "ms": "",
            "pl": "",
            "ru": "Привет, мир! Редактировать (изменено)",
            "sc": "",
            "tc": "",
            "th": "",
            "tr": "",
            "ua": "",
            "vn": ""
        },
        "LIST_COLUMN_LABEL": {
            "ar": "",
            "br": "",
            "de": "Hallo, Welt! Spalte (geändert)",
            "en": "Hello, World! Column (changed)",
            "fr": "",
            "hi": "",
            "id": "",
            "in": "",
            "it": "",
            "ja": "",
            "kz": "",
            "la": "",
            "ms": "",
            "pl": "",
            "ru": "Привет, мир! Колонка (изменено)",
            "sc": "",
            "tc": "",
            "th": "",
            "tr": "",
            "ua": "",
            "vn": ""
        },
        "LIST_FILTER_LABEL": {
            "ar": "Привет, мир! Фильтр (изменено)",
            "br": "Привет, мир! Фильтр (изменено)",
            "de": "Привет, мир! Фильтр (изменено)",
            "en": "Привет, мир! Фильтр (изменено)",
            "fr": "Привет, мир! Фильтр (изменено)",
            "hi": "Привет, мир! Фильтр (изменено)",
            "id": "Привет, мир! Фильтр (изменено)",
            "in": "Привет, мир! Фильтр (изменено)",
            "it": "Привет, мир! Фильтр (изменено)",
            "ja": "Привет, мир! Фильтр (изменено)",
            "kz": "Привет, мир! Фильтр (изменено)",
            "la": "Привет, мир! Фильтр (изменено)",
            "ms": "Привет, мир! Фильтр (изменено)",
            "pl": "Привет, мир! Фильтр (изменено)",
            "ru": "Привет, мир! Фильтр (изменено)",
            "sc": "Привет, мир! Фильтр (изменено)",
            "tc": "Привет, мир! Фильтр (изменено)",
            "th": "Привет, мир! Фильтр (изменено)",
            "tr": "Привет, мир! Фильтр (изменено)",
            "ua": "Привет, мир! Фильтр (изменено)",
            "vn": "Привет, мир! Фильтр (изменено)"
        },
        "ERROR_MESSAGE": {
            "ar": "",
            "br": "",
            "de": "Hallo, Welt! Fehler (geändert)",
            "en": "Hello, World! Error (changed)",
            "fr": "",
            "hi": "",
            "id": "",
            "in": "",
            "it": "",
            "ja": "",
            "kz": "",
            "la": "",
            "ms": "",
            "pl": "",
            "ru": "Привет, мир! Ошибка (изменено)",
            "sc": "",
            "tc": "",
            "th": "",
            "tr": "",
            "ua": "",
            "vn": ""
        },
        "HELP_MESSAGE": {
            "ar": "",
            "br": "",
            "de": "Hallo, Welt! Hilfe (geändert)",
            "en": "Hello, World! Help (changed)",
            "fr": "",
            "hi": "",
            "id": "",
            "in": "",
            "it": "",
            "ja": "",
            "kz": "",
            "la": "",
            "ms": "",
            "pl": "",
            "ru": "Привет, мир! Помощь (изменено)",
            "sc": "",
            "tc": "",
            "th": "",
            "tr": "",
            "ua": "",
            "vn": ""
        }
    },
    "time": {
        "start": 1753790529.430936,
        "finish": 1753790529.487882,
        "duration": 0.05694580078125,
        "processing": 0.0039789676666259766,
        "date_start": "2025-07-29T15:02:09+03:00",
        "date_finish": "2025-07-29T15:02:09+03:00",
        "operating_reset_at": 1753791129,
        "operating": 0
    }
}

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

Название `тип`	Описание
result `object`	Описание пользовательского поля (подробное описание)
time `time`	Информация о времени выполнения запроса

Объект result

Числовые значения ID и SORT приходят строками.

Название `тип`	Описание
ID `string`	Идентификатор пользовательского поля
ENTITY_ID `string`	Объект, к которому привязано поле. Для предложений всегда `CRM_QUOTE`
FIELD_NAME `string`	Полное имя поля с префиксом `UF_CRM_`. Значение поля записывают и читают универсальные методы crm.item.update и crm.item.get с `entityTypeId = 7`. В них имя поля пишется в camelCase: `UF_CRM_MANAGER_NOTE` превращается в `ufCrmManagerNote`. Методы crm.quote.update и crm.quote.get работают с полным именем, но их развитие остановлено. Метод `crm.quote.userfield.get` значения полей в предложениях не возвращает
USER_TYPE_ID `string`	Тип поля. Список значений — в описании параметра `USER_TYPE_ID` метода crm.quote.userfield.add
USER_TYPE_OWNER `string`	Идентификатор приложения, которое зарегистрировало пользовательский тип поля. Возвращается только для полей пользовательского типа
XML_ID `string`	Внешний код. Если не задан — `null`
SORT `string`	Индекс сортировки
MULTIPLE `char`	Множественное ли поле: `Y` или `N`
MANDATORY `char`	Обязательное ли поле: `Y` или `N`
SHOW_FILTER `char`	Режим поля в фильтре списка: `N` — поля нет в фильтре `I` — поиск по точному совпадению `E` — поиск по маске `S` — поиск по подстроке
SHOW_IN_LIST `char`	Показывать ли поле в списке: `Y` или `N`
EDIT_IN_LIST `char`	Разрешено ли редактирование пользователем: `Y` или `N`
IS_SEARCHABLE `char`	Участвуют ли значения поля в поиске: `Y` или `N`
SETTINGS `object`	Настройки типа поля. Кроме настроек, которые принимает crm.quote.userfield.add, может содержать служебные ключи, например `SIZE`, `MIN_LENGTH`, `MAX_LENGTH` у типа `string`. Перечень настроек типа возвращает метод crm.userfield.settings.fields
EDIT_FORM_LABEL `lang_map`	Подпись в форме редактирования на каждом языке
LIST_COLUMN_LABEL `lang_map`	Заголовок в списке на каждом языке
LIST_FILTER_LABEL `lang_map`	Подпись фильтра на каждом языке
ERROR_MESSAGE `lang_map`	Сообщение об ошибке на каждом языке
HELP_MESSAGE `lang_map`	Помощь на каждом языке
LIST `object[]`	Элементы списка. Возвращаются только для полей типа `enumeration`, отсортированы по `SORT`. Каждый элемент содержит: `ID` — идентификатор элемента, его передают в значении поля при записи в предложение `SORT` — индекс сортировки `VALUE` — значение элемента `DEF` — значение по умолчанию: `Y` или `N` Внешний код элемента `XML_ID` метод не возвращает, его возвращает метод crm.quote.userfield.list

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

HTTP-статус: 400

{
    "error": "",
    "error_description": "ID is not defined or invalid."
}

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

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

Статус	Код	Описание	Значение
`400`	Пустое значение	`ID is not defined or invalid.`	`id` не передан или меньше единицы
`400`	Пустое значение	`Access denied.`	Возникает в случаях, когда: у пользователя нет права на чтение предложений поле с переданным `id` принадлежит другому объекту, например лидам
`400`	`ERROR_NOT_FOUND`	`The entity with ID 'id' is not found.`	Пользовательского поля с переданным `id` нет

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

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

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

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

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

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

Получить пользовательское поле предложений по ID crm.quote.userfield.get

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

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

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

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

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

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

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

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

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