Получить доступные типы пользовательских полей userfieldconfig.getTypes

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

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

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

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

Метод userfieldconfig.getTypes возвращает набор доступных типов пользовательских полей для модуля.

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

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

Название
тип

Описание

moduleId*
string

Идентификатор модуля, для которого нужно получить доступные типы полей

Примеры кода

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

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"moduleId":"crm"}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/userfieldconfig.getTypes
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"moduleId":"crm","auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/userfieldconfig.getTypes
        
try
        {
        	const response = await $b24.callMethod(
        		'userfieldconfig.getTypes',
        		{
        			moduleId: 'crm',
        		}
        	);
        
        	const result = response.getData().result;
        	console.info(result);
        }
        catch (error)
        {
        	console.error(error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'userfieldconfig.getTypes',
                    [
                        'moduleId' => 'crm',
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Result: ' . print_r($result, true);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'userfieldconfig.getTypes',
            {
                moduleId: 'crm',
            },
            (result) => {
                result.error()
                    ? console.error(result.error())
                    : console.info(result.data())
                ;
            },
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'userfieldconfig.getTypes',
            [
                'moduleId' => 'crm',
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

HTTP-статус: 200

{
            "result": {
                "types": {
                    "crm": {
                        "userTypeId": "crm",
                        "description": "Привязка к элементам CRM"
                    },
                    "crm_status": {
                        "userTypeId": "crm_status",
                        "description": "Привязка к справочникам CRM"
                    },
                    "money": {
                        "userTypeId": "money",
                        "description": "Деньги"
                    },
                    "employee": {
                        "userTypeId": "employee",
                        "description": "Привязка к сотруднику"
                    },
                    "rest_219_test": {
                        "userTypeId": "rest_219_test",
                        "description": "Test type"
                    },
                    "string": {
                        "userTypeId": "string",
                        "description": "Строка"
                    },
                    "integer": {
                        "userTypeId": "integer",
                        "description": "Целое число"
                    },
                    "double": {
                        "userTypeId": "double",
                        "description": "Число"
                    },
                    "datetime": {
                        "userTypeId": "datetime",
                        "description": "Дата со временем"
                    },
                    "date": {
                        "userTypeId": "date",
                        "description": "Дата"
                    },
                    "boolean": {
                        "userTypeId": "boolean",
                        "description": "Да/Нет"
                    },
                    "address": {
                        "userTypeId": "address",
                        "description": "Адрес"
                    },
                    "url": {
                        "userTypeId": "url",
                        "description": "Ссылка"
                    },
                    "file": {
                        "userTypeId": "file",
                        "description": "Файл"
                    },
                    "enumeration": {
                        "userTypeId": "enumeration",
                        "description": "Список"
                    },
                    "iblock_section": {
                        "userTypeId": "iblock_section",
                        "description": "Привязка к разделам инф. блоков"
                    },
                    "iblock_element": {
                        "userTypeId": "iblock_element",
                        "description": "Привязка к элементам инф. блоков"
                    }
                }
            },
            "time": {
                "start": 1774356634,
                "finish": 1774356634.880673,
                "duration": 0.8806729316711426,
                "processing": 0,
                "date_start": "2026-03-24T15:50:34+03:00",
                "date_finish": "2026-03-24T15:50:34+03:00",
                "operating_reset_at": 1774357234,
                "operating": 0
            }
        }

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

Название
тип

Описание

result
object

Корневой элемент ответа (подробное описание)

time
time

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

Объект result

Название
тип

Описание

types
object

Словарь доступных типов, где ключом является идентификатор типа, а значением объект с полями userTypeId и description

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

HTTP-статус: 400

{
            "error": "",
            "error_description": "The current method required more scopes. (crm)"
        }

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Код

Описание

Значение

-

The current method required more scopes. (crm)

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

-

No settings for UserFieldAccess

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

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

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

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

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут

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

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

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

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