Получить поля пользователя user.fields
Scope:
user,user_brief,user_basicКто может выполнять метод: любой пользователь
Метод user.fields позволяет получить список названий полей пользователя. Метод отдаёт стандартный список полей, использование пользовательских полей не предусмотрено.
Перечень полей пользователей Битрикс24, который будет получен в результате выполнения метода, зависит от скоупа приложения/вебхука. Подробности о доступе к данным пользователей можно узнать в статье.
Без параметров.
Примеры кода
Как использовать примеры в документации
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 '{}' \
https://**put_your_bitrix24_address**/rest/user.fields
try
{
const response = await $b24.callMethod(
"user.fields",
{}
);
const result = response.getData().result;
if(result.error())
{
console.error(result.error());
}
else
{
console.dir(result);
}
}
catch(error)
{
console.error('Error:', error);
}
try {
$response = $b24Service
->core
->call(
'user.fields',
[]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error());
} else {
echo 'Success: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error fetching user fields: ' . $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>';
Обработка ответа
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_TWITTER":"Twitter",
"UF_SKYPE":"Skype",
"UF_DISTRICT":"Район",
"UF_PHONE_INNER":"Внутренний телефон",
"USER_TYPE":"USER_TYPE"
},
"time":{
"start":1721719975.764591,
"finish":1721719975.786585,
"duration":0.02199411392211914,
"processing":0.0005099773406982422,
"date_start":"2024-07-23T07:32:55+00:00",
"date_finish":"2024-07-23T07:32:55+00:00",
"operating":0
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Корневой элемент ответа, который содержит пользовательские поля |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Пригласить пользователя user.add
- Обновить данные пользователя user.update
- Получить список пользователей по фильтру user.get
- Получить информацию о текущем пользователе user.current
- Получить список пользователей с поиском по персональным данным user.search