Документация для разработчиков
Темная тема

user.get

Перечень полей пользователей Битрикс24, который будет получен в результате выполнения метода, зависит от скоупа приложения/вебхука. Подробности о доступе к данным пользователей можно узнать в статье.

Описание

Получение фильтрованного списка пользователей. Метод вернет всех пользователей за исключением: ботов, пользователей для e-mail, пользователей для Открытых Линий, пользователей Реплики.

Вызов

BX24.callMethod('user.get', {"ID": 1});

Запрос

https://my.bitrix24.ru/rest/user.get.json?ID=1&auth=b961afd4148963c5d54ebeb17123d1fc

Ответ

{"result":[{"ID":"1","ACTIVE":true,"EMAIL":"sigurd@example.com","NAME":"Administrator","LAST_NAME":"","SECOND_NAME":"","PERSONAL_GENDER":"",
"PERSONAL_PROFESSION":"","PERSONAL_WWW":"","PERSONAL_BIRTHDAY":"1955-04-10T00:00:00+03:00","PERSONAL_PHOTO":"\/upload\/main\/80c\/44169_C5_PrimalWaterE500CC.jpg",
"PERSONAL_ICQ":"","PERSONAL_PHONE":"","PERSONAL_FAX":"","PERSONAL_MOBILE":"","PERSONAL_PAGER":"","PERSONAL_STREET":"","PERSONAL_CITY":"","PERSONAL_STATE":"",
"PERSONAL_ZIP":"","PERSONAL_COUNTRY":"0","WORK_COMPANY":"","WORK_POSITION":"","UF_DEPARTMENT":[128],"UF_INTERESTS":null,"UF_SKILLS":null,"UF_WEB_SITES":null,
"UF_XING":null,"UF_LINKEDIN":null,"UF_FACEBOOK":null,"UF_TWITTER":null,"UF_SKYPE":null,"UF_DISTRICT":null,"UF_PHONE_INNER":null}],"total":1}

Параметры

ПараметрОписание
sort поле, по которому сортируются результаты
order направление сортировки
  • ASC - по возрастанию.
  • DESC - по убыванию
FILTER Дополнительно можно указывать любые параметры из user.fields для фильтрации по их значениям. Кроме основных полей, доступны дополнительные:
  • UF_DEPARTMENT - принадлежность к структуре компании;
  • UF_PHONE_INNER - внутренний телефонный номер;
  • IS_ONLINE - [Y/N] - позволяет показать только авторизованных или нет пользователей.
  • NAME_SEARCH - быстрый поиск по персональным данным.
  • USER_TYPE - тип пользователя. Может принимать следующие значения:
    employee - сотрудник,
    extranet - пользователь экстранета,
    email - почтовый пользователь
  • ACTIVE - при значении true исключает из запроса уволенных пользователей.

Параметры фильтрации могут принимать значение массивов.

ADMIN_MODE Ключ для работы 'ADMIN_MODE': 'True' в режиме администратора, служит для получения данных о любых пользователях.


© «Битрикс», 2001-2022, «1С-Битрикс», 2022
Наверх