метод REST scope: crm

crm.deal.userfield.get

Получить пользовательское поле сделок по id

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

Описание

Метод crm.deal.userfield.get возвращает пользовательское поле сделок по идентификатору.

Параметры

id integer обязательный

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

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

Примеры запроса

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.deal.userfield.get

Ответ

HTTP-статус: 200

{
    "result": {
        "ID": "6997",
        "ENTITY_ID": "CRM_DEAL",
        "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

Корневой элемент ответа, содержит информацию о полях пользовательского поля. Итоговый перечень полей зависит от типа поля, подробное описание полей можно найти в методе crm.deal.userfield.add

time time

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

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

HTTP-статус: 400

{
    "error": "",
    "error_description": "ID is not defined or invalid."
}
Код Описание Значение
403 Access denied Возникает в случаях, когда:
- у пользователя нет права «чтения» сделок
- пользователь пытается получить пользовательское поле, не привязанное к сделкам
400 ID is not defined or invalid Переданный id меньше или равен нулю, либо же не передан вовсе
ERROR_NOT_FOUND The entity with ID 'id' is not found Пользовательское поле с переданным id не найдено

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.