метод REST scope: im

im.search.user.list

Найти пользователей

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

Описание

Метод im.search.user.list выполняет поиск пользователей по имени, фамилии, должности и подразделению.

Параметры

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

Поисковая фраза. Минимальное количество символов для поиска — 2

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

Искать только среди бизнес-пользователей.

Допустимые значения:
- Y — да
- N — нет

Значение по умолчанию — N

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

Смещение выборки пользователей. По умолчанию 0

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

Количество элементов в выборке. По умолчанию 10. Максимальное значение 50

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

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{"FIND":"Иван","BUSINESS":"N","OFFSET":0,"LIMIT":10}' \
  https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/im.search.user.list

Ответ

HTTP-статус: 200

{
    "result": {
        "103": {
            "id": 103,
            "name": "Светлана Иванова",
            "first_name": "Светлана",
            "last_name": "Иванова",
            "work_position": "Руководитель ИТ-отдела",
            "color": "#4ba984",
            "avatar": "https://example.bitrix24.ru/upload/main/avatar.png",
            "gender": "F",
            "birthday": "08-03",
            "extranet": false,
            "network": false,
            "bot": false,
            "connector": false,
            "external_auth_id": "socservices",
            "status": "online",
            "idle": false,
            "last_activity_date": "2026-03-04T15:40:56+03:00",
            "mobile_last_date": false,
            "departments": [1, 7],
            "absent": false,
            "phones": {
                "work_phone": "79123456789",
                "personal_mobile": "81234567890",
                "inner_phone": "78"
            }
        }
    },
    "total": 2,
    "time": {
        "start": 1772628089,
        "finish": 1772628089.061656,
        "duration": 0.06165599822998047,
        "processing": 0,
        "date_start": "2026-03-04T15:41:29+03:00",
        "date_finish": "2026-03-04T15:41:29+03:00",
        "operating_reset_at": 1772628689,
        "operating": 0
    }
}

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

result object

Найденные пользователи. Ключ каждого элемента равен идентификатору пользователя. Если ничего не найдено, метод возвращает пустой массив.

Структура объекта пользователя подробно описана ниже

total integer

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

next integer

Смещение следующей страницы. Поле возвращается, если есть следующая страница

time time

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

Обработка ошибок

HTTP-статус: 400

{
    "error": "FIND_SHORT",
    "error_description": "Too short a search phrase."
}
Код Описание Значение
FIND_SHORT Too short a search phrase Поисковая фраза не передана или слишком короткая для внутреннего фильтра поиска

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

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