Получить поля пользователя user.fields
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
user,user_brief,user_basicКто может выполнять метод: любой пользователь
Метод user.fields возвращает коды и названия полей профиля пользователя: стандартных и пользовательских полей с префиксом UF_USR_.
Перечень полей пользователей Битрикс24, который будет получен в результате выполнения метода, зависит от скоупа приложения/вебхука. Какие поля доступны в каждой версии — в статье Версии скоупа user.
Параметры метода
Без параметров.
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/user.fields
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/user.fields
// 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 the payload returned in result (match the "response handling" section of the page)
type UserFieldsResult = {
[field: string]: string
}
try {
const response = await $b24.actions.v2.call.make<UserFieldsResult>({
method: 'user.fields',
params: {},
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 fields:', 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 fetchUserFields() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'user.fields',
params: {},
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 fields:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', fetchUserFields)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.user.fields().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 {
$response = $b24Service
->core
->call(
'user.fields',
[]
);
$result = $response
->getResponseData()
->getResult();
print_r($result);
} catch (Throwable $e) {
echo $e->getMessage();
}
BX24.callMethod(
"user.fields",
{},
function(result)
{
if(result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'user.fields',
[]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "user.fields", b24.Params{}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("user.fields: %w", err)
}
// result — объект «код поля: название поля»
var fields map[string]*string
if err := json.Unmarshal(res.Result, &fields); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
for code, title := range fields {
if title != nil {
fmt.Println(code, *title)
}
}
Обработка ответа
HTTP-статус: 200
{
"result": {
"ID": "ID",
"XML_ID": "Внешний код",
"ACTIVE": "Активность",
"NAME": "Имя",
"LAST_NAME": "Фамилия",
"SECOND_NAME": "Отчество",
"TITLE": "Список пользователей",
"EMAIL": "E-Mail",
"LAST_LOGIN": "Последняя авторизация",
"DATE_REGISTER": "Дата регистрации",
"TIME_ZONE": "TIME_ZONE",
"IS_ONLINE": "IS_ONLINE",
"TIMESTAMP_X": "TIMESTAMP_X",
"LAST_ACTIVITY_DATE": "LAST_ACTIVITY_DATE",
"PERSONAL_GENDER": "Пол",
"PERSONAL_PROFESSION": "Профессия",
"PERSONAL_WWW": "Домашняя страничка",
"PERSONAL_BIRTHDAY": "Дата рождения",
"PERSONAL_PHOTO": "Фотография",
"PERSONAL_ICQ": "ICQ",
"PERSONAL_PHONE": "Личный телефон",
"PERSONAL_FAX": "Факс",
"PERSONAL_MOBILE": "Личный мобильный",
"PERSONAL_PAGER": "Пейджер",
"PERSONAL_STREET": "Улица проживания",
"PERSONAL_CITY": "Город проживания",
"PERSONAL_STATE": "Область / край",
"PERSONAL_ZIP": "Почтовый индекс",
"PERSONAL_COUNTRY": "Страна",
"PERSONAL_MAILBOX": "Почтовый ящик",
"PERSONAL_NOTES": "Дополнительные заметки",
"WORK_PHONE": "Телефон компании",
"WORK_COMPANY": "Компания",
"WORK_POSITION": "Должность",
"WORK_DEPARTMENT": "Отдел",
"WORK_WWW": "Сайт компании",
"WORK_FAX": "WORK_FAX",
"WORK_PAGER": "WORK_PAGER",
"WORK_STREET": "WORK_STREET",
"WORK_MAILBOX": "WORK_MAILBOX",
"WORK_CITY": "Город работы",
"WORK_STATE": "WORK_STATE",
"WORK_ZIP": "WORK_ZIP",
"WORK_COUNTRY": "WORK_COUNTRY",
"WORK_PROFILE": "WORK_PROFILE",
"WORK_LOGO": "WORK_LOGO",
"WORK_NOTES": "WORK_NOTES",
"UF_SKYPE_LINK": "Ссылка на чат в Skype",
"UF_ZOOM": "Zoom",
"UF_EMPLOYMENT_DATE": "Дата принятия на работу",
"UF_TIMEMAN": "Учет рабочего времени",
"UF_DEPARTMENT": "Подразделения",
"UF_INTERESTS": "Интересы",
"UF_SKILLS": "Навыки",
"UF_WEB_SITES": "Другие сайты",
"UF_XING": "Xing",
"UF_LINKEDIN": "LinkedIn",
"UF_FACEBOOK": "Facebook",
"UF_TWITTER": "Twitter",
"UF_SKYPE": "Microsoft Teams",
"UF_DISTRICT": "Район",
"UF_PHONE_INNER": "Внутренний телефон",
"UF_USR_1623996826645": "Подпись",
"USER_TYPE": "USER_TYPE"
},
"time": {
"start": 1793286069,
"finish": 1793286069.582253,
"duration": 0.5822529792785645,
"processing": 0,
"date_start": "2026-10-29T18:01:09+03:00",
"date_finish": "2026-10-29T18:01:09+03:00",
"operating_reset_at": 1793286660,
"operating": 0
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Объект вида Содержит стандартные поля профиля, которые разрешены версией скоупа — список по версиям в статье Версии скоупа user. Типы и описания стандартных полей — в таблице полей пользователя. Пользовательские поля с префиксом Названия берутся из интерфейса Битрикс24 и могут не совпадать с назначением поля. Например, у поля |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 401
{
"error": "INVALID_CREDENTIALS",
"error_description": "Invalid request credentials"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только |
|
error_description |
Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки |
Возможные коды ошибок
У метода нет параметров, поэтому собственных ошибок у него нет. Метод возвращает только системные ошибки, например:
|
Статус |
Код |
Описание |
Значение |
|
|
|
Invalid request credentials |
Неверный код вебхука или токен авторизации |
|
|
|
The request requires higher privileges than provided by the webhook token |
У вебхука или приложения нет ни одной версии скоупа: |
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |