Получить список пользовательских полей user.userfield.list
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
user.userfieldКто может выполнять метод: администратор
Метод user.userfield.list получает список пользовательских полей по фильтру.
Параметры метода
|
Название |
Описание |
|
order |
Сортировка выбранных пользовательских полей в формате Возможные значения для
Возможные значения для
|
|
filter |
Фильтр выбранных пользовательских полей в формате Возможные значения для Ключу может быть задан дополнительный префикс, уточняющий поведение фильтра. Возможные значения префикса:
|
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"order":{"id":"desc"},"filter":{"id":13}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/user.userfield.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"order":{"id":"desc"},"filter":{"id":13},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/user.userfield.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 user field returned in result[]
type UserUserfieldItem = {
ID: string
ENTITY_ID: string
FIELD_NAME: string
USER_TYPE_ID: string
XML_ID: string | null
SORT: string
MULTIPLE: 'Y' | 'N'
MANDATORY: 'Y' | 'N'
SHOW_FILTER: string
SHOW_IN_LIST: 'Y' | 'N'
EDIT_IN_LIST: 'Y' | 'N'
IS_SEARCHABLE: 'Y' | 'N'
SETTINGS: Record<string, unknown>
LIST?: Array<{ ID: string; SORT: string; VALUE: string; DEF: 'Y' | 'N'; XML_ID: string }>
}
try {
const response = await $b24.actions.v2.call.make<UserUserfieldItem[]>({
method: 'user.userfield.list',
params: {
order: { id: 'desc' },
filter: { id: 13 },
},
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('Loaded user fields:', 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 listUserUserfields() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'user.userfield.list',
params: {
order: { id: 'desc' },
filter: { id: 13 },
},
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('Loaded user fields:', result.length, result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', listUserUserfields)
</script>
Пример
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
order = {
"ID": "desc",
"SORT": "asc",
}
filter = {
"USER_TYPE_ID": "string",
"SHOW_IN_LIST": "Y",
}
try:
bitrix_response = client.user.userfield.list(
order=order,
filter=filter,
).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("Bitrix SDK error", error.message, sep="\n")
except Exception as error:
print("Unexpected error", error, sep="\n")
Пример as_list
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
order = {
"ID": "desc",
}
filter = {
"SHOW_IN_LIST": "Y",
}
try:
bitrix_response = client.user.userfield.list(
order=order,
filter=filter,
).as_list().response
result = bitrix_response.result
for item in result:
print(item)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print("Bitrix SDK error", error.message, sep="\n")
except Exception as error:
print("Unexpected error", error, sep="\n")
Пример as_list_fast
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
order = {
"ID": "desc",
}
filter = {
"SHOW_IN_LIST": "Y",
}
try:
bitrix_response = client.user.userfield.list(
order=order,
filter=filter,
).as_list_fast(descending=True).response
result = bitrix_response.result
for item in result:
print(item)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print("Bitrix SDK error", error.message, sep="\n")
except Exception as error:
print("Unexpected error", error, sep="\n")
try {
$response = $b24Service
->core
->call(
'user.userfield.list',
[
'order' => [
'id' => 'desc',
],
'filter' => [
'id' => 13
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
// Нужная вам логика обработки данных
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error fetching user fields: ' . $e->getMessage();
}
BX24.callMethod(
"user.userfield.list",
{
order: {
id: 'desc',
},
filter: {
id: 13
},
},
function(result) {
if (result.error()) {
console.error(result.error());
} else {
console.info(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'user.userfield.list',
[
'order' => [
'id' => 'desc',
],
'filter' => [
'id' => 13,
],
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "user.userfield.list", b24.Params{
"order": b24.Params{
"id": "desc",
},
"filter": b24.Params{
"id": 13,
},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("user.userfield.list: %w", err)
}
var items []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, &items); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
for _, it := range items {
fmt.Println(it.ID, it.EntityID)
}
// Total и Next заполняют списочные методы; для полного
// обхода списка есть client.Core().Pages и Scan.
if res.Total != nil {
fmt.Println("всего:", *res.Total)
}
Обработка ответа
HTTP-статус: 200
{
"result":[
{
"ID":"176",
"ENTITY_ID":"USER",
"FIELD_NAME":"UF_USR_1724228142162",
"USER_TYPE_ID":"enumeration",
"XML_ID":null,
"SORT":"100",
"MULTIPLE":"Y",
"MANDATORY":"N",
"SHOW_FILTER":"E",
"SHOW_IN_LIST":"Y",
"EDIT_IN_LIST":"Y",
"IS_SEARCHABLE":"N",
"SETTINGS":{
"DISPLAY":"UI",
"LIST_HEIGHT":1,
"CAPTION_NO_VALUE":"",
"SHOW_NO_VALUE":"Y"
},
"LIST":[
{
"ID":"26",
"SORT":"0",
"VALUE":"1",
"DEF":"N",
"XML_ID":"2a53ce08b86a6aba152b1b19204fdef2"
},
{
"ID":"27",
"SORT":"100",
"VALUE":"2",
"DEF":"N",
"XML_ID":"292df2be1171ed6ab038996deac29ac8"
},
{
"ID":"28",
"SORT":"200",
"VALUE":"3",
"DEF":"N",
"XML_ID":"3c5af70eafbba79a6cf52e299ed75123"
}
]
},
{
"ID":"177",
"ENTITY_ID":"USER",
"FIELD_NAME":"UF_USR_MONEY",
"USER_TYPE_ID":"money",
"XML_ID":null,
"SORT":"100",
"MULTIPLE":"N",
"MANDATORY":"N",
"SHOW_FILTER":"N",
"SHOW_IN_LIST":"Y",
"EDIT_IN_LIST":"Y",
"IS_SEARCHABLE":"N",
"SETTINGS":{
"DEFAULT_VALUE":""
}
}
],
"total":2,
"time":{
"start":1747313326.788124,
"finish":1747313328.641663,
"duration":1.853538990020752,
"processing":0.011211156845092773,
"date_start":"2025-05-15T14:48:46+02:00",
"date_finish":"2025-05-15T14:48:48+02:00",
"operating":0
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Массив объектов с описанием пользовательских полей |
|
total |
Общее количество найденных записей |
|
time |
Информация о времени выполнения запроса |
Поля объекта result
|
Название |
Описание |
|
ID |
Идентификатор пользовательского поля |
|
ENTITY_ID |
Идентификатор объекта, к которому относится поле. Для пользовательских полей сотрудников — |
|
FIELD_NAME |
Код пользовательского поля |
|
USER_TYPE_ID |
Тип пользовательского поля |
|
Внешний идентификатор пользовательского поля |
|
|
SORT |
Индекс сортировки |
|
MULTIPLE |
Признак множественного поля. Возможные значения: |
|
MANDATORY |
Признак обязательного поля. Возможные значения: |
|
SHOW_FILTER |
Режим показа поля в фильтре списка пользователей |
|
SHOW_IN_LIST |
Признак показа поля в списке пользователей. Возможные значения: |
|
EDIT_IN_LIST |
Признак возможности редактировать поле в списке пользователей. Возможные значения: |
|
IS_SEARCHABLE |
Признак участия значений поля в поиске. Возможные значения: |
|
EDIT_FORM_LABEL |
Подпись поля в форме редактирования |
|
LIST_COLUMN_LABEL |
Заголовок поля в списке пользователей |
|
LIST_FILTER_LABEL |
Подпись поля в фильтре списка пользователей |
|
ERROR_MESSAGE |
Сообщение об ошибке при проверке значения поля |
|
HELP_MESSAGE |
Подсказка к полю |
|
USER_TYPE_OWNER |
Идентификатор приложения — владельца типа пользовательского поля. Возвращается для типов, зарегистрированных приложениями |
|
SETTINGS |
Настройки пользовательского поля. Набор полей зависит от значения |
|
LIST |
Элементы списка. Поле возвращается, если |
Поля элементов LIST
|
Название |
Описание |
|
ID |
Идентификатор элемента списка |
|
SORT |
Индекс сортировки |
|
VALUE |
Значение элемента списка |
|
DEF |
Признак значения по умолчанию. Возможные значения: |
|
XML_ID |
Внешний идентификатор элемента списка |
Обработка ошибок
HTTP-статус: 400
{
"error":"",
"error_description":"Access denied."
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только |
|
error_description |
Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки |
Возможные коды ошибок
|
Код |
Описание |
Значение |
|
Пустая строка |
Access denied. |
Недостаточно прав для получения списка пользовательских полей |
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |