Получить список зарегистрированных типов пользовательских полей userfieldtype.list
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
placementКто может выполнять метод: администратор
Метод userfieldtype.list возвращает типы пользовательских полей, которые приложение зарегистрировало методом userfieldtype.add. Для каждого типа метод отдает код, адрес обработчика, название и описание.
Поле такого типа выводится в карточке элемента CRM, а его содержимое загружает обработчик приложения. Общая схема работы описана в статье Пользовательские типы полей.
Используйте метод, чтобы узнать код типа USER_TYPE_ID перед вызовом userfieldtype.update или userfieldtype.delete.
Метод работает только в контексте приложения
Параметры метода
|
Название |
Описание |
|
start |
Смещение для постраничной навигации. Метод возвращает не более 50 записей за вызов. Чтобы получить следующую страницу, передайте значение |
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"start":0,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/userfieldtype.list
// 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 each UserFieldTypeItem returned in result[]
type UserFieldTypeItem = {
USER_TYPE_ID: string
HANDLER: string
TITLE: string
DESCRIPTION: string
}
// userfieldtype.list returns a single page (max 50 records). For the whole result set
// use a list helper: $b24.actions.v2.callList.make() returns every record as one
// array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
try {
const response = await $b24.actions.v2.call.make<UserFieldTypeItem[]>({
method: 'userfieldtype.list',
params: {
start: 0,
},
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('User field types count:', result.length, result)
}
} 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 listUserFieldTypes() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
// userfieldtype.list returns a single page (max 50 records). For the whole result set
// use a list helper: $b24.actions.v2.callList.make() returns every record as one
// array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
const response = await $b24.actions.v2.call.make({
method: 'userfieldtype.list',
params: {
start: 0,
},
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('User field types count:', result.length, result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', listUserFieldTypes)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.userfieldtype.list(
start=0,
).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 {
$userFieldTypesResult = $serviceBuilder->getPlacementScope()->userFieldType()->list();
$userFieldTypes = $userFieldTypesResult->getUserFieldTypes();
foreach ($userFieldTypes as $userFieldType) {
print("Description: " . $userFieldType->DESCRIPTION . "\n");
print("Handler: " . $userFieldType->HANDLER . "\n");
print("Title: " . $userFieldType->TITLE . "\n");
print("User Type ID: " . $userFieldType->USER_TYPE_ID . "\n");
}
} catch (Throwable $e) {
print("Error: " . $e->getMessage());
}
BX24.callMethod(
'userfieldtype.list',
{ start: 0 },
function(result)
{
if(result.error())
console.error(result.error());
else
console.log(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'userfieldtype.list',
['start' => 0]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "userfieldtype.list", nil, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("userfieldtype.list: %w", err)
}
var items []struct {
UserTypeID string `json:"USER_TYPE_ID"`
Handler string `json:"HANDLER"`
Title string `json:"TITLE"`
Description string `json:"DESCRIPTION"`
}
if err := json.Unmarshal(res.Result, &items); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
for _, it := range items {
fmt.Println(it.UserTypeID, it.Handler)
}
// Total и Next заполняют списочные методы; для полного
// обхода списка есть client.Core().Pages и Scan.
if res.Total != nil {
fmt.Println("всего:", *res.Total)
}
Обработка ответа
HTTP-статус: 200
{
"result": [
{
"USER_TYPE_ID": "my_custom_type_2",
"HANDLER": "http:\/\/test.com\/test2.php",
"TITLE": "test title 2",
"DESCRIPTION":"test desc 2"
},
{
"USER_TYPE_ID": "my_custom_type_1",
"HANDLER": "http:\/\/test.com\/test1.php",
"TITLE": "test title 1",
"DESCRIPTION": "test desc 1"
},
{
"USER_TYPE_ID": "test_user_type",
"HANDLER": "http:\/\/test.com\/test.php",
"TITLE": "test title",
"DESCRIPTION": "test desc"
}
],
"total": 3,
"time":{
"start":1724423274.842117,
"finish":1724423275.558021,
"duration":0.7159039974212646,
"processing":0.0018908977508544922,
"date_start":"2024-08-23T16:27:54+02:00",
"date_finish":"2024-08-23T16:27:55+02:00",
"operating":0
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Список зарегистрированных типов пользовательских полей (подробное описание). Если приложение не зарегистрировало ни одного типа, список пустой |
|
next |
Смещение для следующей страницы. Передайте значение в параметр |
|
total |
Общее количество типов, которые зарегистрировало приложение |
|
time |
Информация о времени выполнения запроса |
Элемент массива result
Значения полей приложение задает при регистрации типа методом userfieldtype.add.
|
Название |
Описание |
|
USER_TYPE_ID |
Короткий код типа, переданный при регистрации. Его принимают userfieldtype.update и userfieldtype.delete. Полный код типа для создания поля собирается по форме |
|
HANDLER |
Адрес обработчика типа. Битрикс24 загружает этот адрес во фрейме внутри поля |
|
TITLE |
Название типа в административном интерфейсе настройки пользовательских полей |
|
DESCRIPTION |
Описание типа в административном интерфейсе настройки пользовательских полей |
Обработка ошибок
HTTP-статус: 403
{
"error": "WRONG_AUTH_TYPE",
"error_description": "Current authorization type is denied for this method Application context required"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только |
|
error_description |
Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки |
Возможные коды ошибок
|
Статус |
Код |
Описание |
Значение |
|
|
|
Current authorization type is denied for this method Application context required |
Метод вызван не в контексте приложения, например через вебхук |
|
|
|
Access denied! |
Метод вызвал пользователь без прав администратора |
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |