Получить пользовательское поле сделок по id crm.deal.userfield.get

Scope: crm

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

Метод 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
        
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.deal.userfield.get
        
try
        {
        	const response = await $b24.callMethod(
        		'crm.deal.userfield.get',
        		{
        			id: 399,
        		}
        	);
        	
        	const result = response.getData().result;
        	result.error()
        		? console.error(result.error())
        		: console.info(result)
        	;
        }
        catch( error )
        {
        	console.error('Error:', error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.deal.userfield.get',
                    [
                        'id' => 399,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                echo 'Error: ' . $result->error();
            } else {
                echo 'Data: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting deal user field: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'crm.deal.userfield.get',
            {
                id: 399,
            },
            (result) => {
                result.error()
                    ? console.error(result.error())
                    : console.info(result.data())
                ;
            },
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'crm.deal.userfield.get',
            [
                'id' => 399
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

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."
        }

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

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

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

Код

Описание

Значение

403

Access denied

Возникает в случаях, когда:

  • у пользователя нет административных прав
  • пользователь пытается получить пользовательское поле, не привязанное к сделкам

400

ID is not defined or invalid

Переданный id меньше или равен нулю, либо же не передан вовсе

ERROR_NOT_FOUND

The entity with ID 'id' is not found

Пользовательское поле с переданным id не найдено

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

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

Код
Текст ошибки

Описание

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

Превышен лимит на интенсивность запросов

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

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

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

Предыдущая
Изменить существующее пользовательское поле сделок
Следующая
Получить список пользовательских полей сделок