метод REST scope: user, user_brief, user_basic

user.get

Получить список пользователей по фильтру

Кто может выполнять: любой пользователь

Описание

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

По умолчанию метод сортирует пользователей по возрастанию ID.

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

Параметры

sort string необязательный

Поле, по которому сортируются результаты. Сортировка работает по всем полям из user.add

order string необязательный

Направление сортировки:
- ASC — по возрастанию
- DESC — по убыванию

FILTER string необязательный

Дополнительно можно указывать любые параметры из user.add для фильтрации по их значениям. Кроме основных полей, доступны дополнительные:
- UF_DEPARTMENT — принадлежность к структуре компании;
- UF_PHONE_INNER — внутренний телефонный номер;
- IS_ONLINE — [Y|N] позволяет показать только авторизованных или нет пользователей.
- NAME_SEARCH — быстрый поиск по персональным данным.
- USER_TYPE — тип пользователя. Может принимать следующие значения:
- employee — сотрудник,
- extranet — пользователь экстранета,
- email — почтовый пользователь
- ACTIVE — при значении *true* исключает из запроса уволенных пользователей.

Параметры фильтрации могут принимать значение массивов.
Ключу может быть задан дополнительный префикс, уточняющий поведение фильтра. Возможные значения префикса:

  • >= — больше либо равно
  • > — больше
  • <= — меньше либо равно
  • < — меньше
  • @ — IN (в качестве значения передаётся массив)
  • !@— NOT IN (в качестве значения передаётся массив)
  • % — LIKE, поиск по подстроке. Символ % в значении фильтра передавать не нужно. Поиск ищет подстроку в любой позиции строки
  • =% — LIKE, поиск по подстроке. Символ % нужно передавать в значении. Примеры:
    - "мол%" — ищем значения, начинающиеся с «мол»
    - "%мол" — ищем значения, заканчивающиеся на «мол»
    - "%мол%" — ищем значения, где «мол» может быть в любой позиции
  • %= — LIKE (см. описание выше)
  • !% — NOT LIKE, поиск по подстроке. Символ % в значении фильтра передавать не нужно. Поиск идет с обоих сторон.
  • !=% — NOT LIKE, поиск по подстроке. Символ % нужно передавать в значении. Примеры:
    - "мол%" — ищем значения, не начинающиеся с «мол»
    - "%мол" — ищем значения, не заканчивающиеся на «мол»
    - "%мол%" — ищем значения, где подстроки «мол» нет в любой позиции
  • !%= — NOT LIKE (см. описание выше)
  • = — равно, точное совпадение (используется по умолчанию)
  • != - не равно
  • ! — не равно

Значения полей с датой и временем передавайте в формате ISO 8601, например 2020-01-01T00:00:00+03:00, или в формате даты вашего Битрикс24. Это относится к полям TIMESTAMP_X, DATE_REGISTER, LAST_LOGIN, LAST_ACTIVITY_DATE, PERSONAL_BIRTHDAY, UF_EMPLOYMENT_DATE и к пользовательским полям типа дата и дата со временем. Если значение не распознано как дата, условие не отберет ни одной записиы

ADMIN_MODE boolean необязательный

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

select array необязательный

Массив с названиями полей, которые вернутся в ответе. Без этого параметра метод возвращает все поля, доступные скоупу приложения или вебхука.

При выборке используйте маски:

  • * — все доступные поля
  • UF_* — все доступные пользовательские поля, в том числе созданные в Битрикс24

Недоступные скоупу и несуществующие поля метод пропускает без ошибки

IMAGE_RESIZE string необязательный

Размер копии фотографии в поле PERSONAL_PHOTO:

  • small — 150 × 150 пикселей
  • medium — 300 × 300 пикселей
  • large — 1000 × 1000 пикселей

Без этого параметра метод возвращает ссылку на исходное изображение

start integer необязательный

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

Размер страницы результатов всегда статичный: 50 записей.

Чтобы выбрать вторую страницу результатов, необходимо передавать значение 50. Чтобы выбрать третью страницу результатов — значение 100 и так далее.

Формула расчета значения параметра start:

start = (N-1) * 50, где N — номер нужной страницы

Примеры запроса

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
    "UF_DEPARTMENT": 1,
    "SORT": "ID",
    "ORDER": "asc",
    "start": 10
}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/user.get

Ответ

HTTP-статус: 200

{
    "result": [
        {
            "ID": "1",
            "ACTIVE": true,
            "NAME": "Вадим",
            "LAST_NAME": "Валеев",
            "SECOND_NAME": "",
            "EMAIL": "v.r.valeev@bitrix.com",
            "LAST_LOGIN": "2024-07-25T13:06:54+00:00",
            "DATE_REGISTER": "2024-07-15T00:00:00+00:00",
            "TIME_ZONE": "",
            "IS_ONLINE": "Y",
            "TIMESTAMP_X": {
            },
            "LAST_ACTIVITY_DATE": {
            },
            "PERSONAL_GENDER": "",
            "PERSONAL_WWW": "",
            "PERSONAL_BIRTHDAY": "2018-07-14T00:00:00+00:00",
            "PERSONAL_MOBILE": "",
            "PERSONAL_CITY": "",
            "WORK_PHONE": "",
            "WORK_POSITION": "",
            "UF_EMPLOYMENT_DATE": "",
            "UF_DEPARTMENT": [1],
            "USER_TYPE": "employee"
        },
        {
            "ID": "3",
            "ACTIVE": true,
            "NAME": "Иван",
            "LAST_NAME": "Иванов",
            "EMAIL": "test@gmail.com",
            "LAST_LOGIN": "2024-07-24T09:01:55+00:00",
            "DATE_REGISTER": "2024-07-22T00:00:00+00:00",
            "IS_ONLINE": "N",
            "TIMESTAMP_X": {
            },
            "LAST_ACTIVITY_DATE": {
            },
            "PERSONAL_GENDER": "",
            "PERSONAL_BIRTHDAY": "",
            "WORK_POSITION": "",
            "UF_EMPLOYMENT_DATE": "",
            "UF_DEPARTMENT": [1],
            "USER_TYPE": "employee"
        }
    ],
    "total": 2,
    "time": {
        "start": 1721913235.39648,
        "finish": 1721913235.45078,
        "duration": 0.05430006980896,
        "processing": 0.0187909603118897,
        "date_start": "2024-07-25T13:13:55+00:00",
        "date_finish": "2024-07-25T13:13:55+00:00",
        "operating": 0
    }
}

Возвращаемые данные

result object

Корневой элемент ответа, который содержит отфильтрованный список пользователей

total integer

Общее количество найденных записей

time time

Информация о времени выполнения запроса

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.