Найти пользователей im.search.user.list

Scope: im

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

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

Параметры метода

Обязательные параметры отмечены *

Название `Тип`	Описание
FIND* `string`	Поисковая фраза. Минимальное количество символов для поиска — `3`
BUSINESS `string`	Искать только среди бизнес-пользователей. Допустимые значения: `Y` — да `N` — нет Значение по умолчанию — `N`
OFFSET `integer`	Смещение выборки пользователей. По умолчанию `0`
LIMIT `integer`	Количество элементов в выборке. По умолчанию `10`. Максимальное значение `50`

Примеры кода

Как использовать примеры в документации

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

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

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

try {
          const response = await $b24.callMethod('im.search.user.list', {
            FIND: 'Иван',
            BUSINESS: 'N',
            OFFSET: 0,
            LIMIT: 10,
          });
        
          const { result, total, next } = response.getData();
          console.log(result, total, next);
        } catch (error) {
          console.error(error);
        }

try {
            $response = $b24Service->core->call(
                'im.search.user.list',
                [
                    'FIND' => 'Иван',
                    'BUSINESS' => 'N',
                    'OFFSET' => 0,
                    'LIMIT' => 10,
                ]
            );
        
            $result = $response->getResponseData()->getResult();
        
            if ($result->error()) {
                echo 'Error: ' . $result->error();
            } else {
                var_dump($result->data());
            }
        } catch (Throwable $exception) {
            echo $exception->getMessage();
        }

BX24.callMethod(
            'im.search.user.list',
            {
                FIND: 'Иван',
                BUSINESS: 'N',
                OFFSET: 0,
                LIMIT: 10,
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error().ex);
                } else {
                    console.log(result.data(), result.total(), result.next());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'im.search.user.list',
            [
                'FIND' => 'Иван',
                'BUSINESS' => 'N',
                'OFFSET' => 0,
                'LIMIT' => 10,
            ]
        );
        
        if (!empty($result['error'])) {
            echo 'Error: ' . $result['error_description'];
        } else {
            var_dump($result['result']);
        }

Обработка ответа

HTTP-код: 200

{
            "result": [
                {
                    "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 `array`	Список найденных пользователей. Структура объекта пользователя подробно описана ниже
total `integer`	Общее количество найденных пользователей
next `integer`	Смещение следующей страницы. Поле возвращается, если есть следующая страница
time `time`	Информация о времени выполнения запроса

Объект пользователя

Название `Тип`	Описание
id `integer`	Идентификатор пользователя
name `string`	Имя и фамилия пользователя
first_name `string`	Имя пользователя
last_name `string`	Фамилия пользователя
work_position `string`	Должность пользователя
color `string`	Цвет пользователя в формате HEX
avatar `string` `null`	Ссылка на аватар пользователя
gender `string`	Пол пользователя: `M` или `F`
birthday `string` `boolean`	День рождения в формате `DD-MM` или `false`
extranet `boolean`	Признак экстранет-пользователя
network `boolean`	Признак пользователя Bitrix24 Network
bot `boolean`	Признак пользователя-бота
connector `boolean`	Признак пользователя-коннектора открытых линий
external_auth_id `string`	Идентификатор внешней авторизации
status `string`	Текущий статус пользователя
idle `string` `boolean`	Время перехода в статус «Отошел» в формате ISO 8601 (RFC3339) или `false`
last_activity_date `string` `boolean`	Время последней активности в формате ISO 8601 (RFC3339) или `false`
mobile_last_date `string` `boolean`	Время последней мобильной активности в формате ISO 8601 (RFC3339) или `false`
departments `array`	Массив идентификаторов подразделений
absent `string` `boolean`	Дата окончания отсутствия в формате ISO 8601 (RFC3339) или `false`
phones `object`	Телефоны пользователя или `false`. Структура объекта подробно описана ниже

Объект phones

Название `Тип`	Описание
work_phone `string`	Рабочий телефон
personal_mobile `string`	Мобильный телефон
inner_phone `string`	Внутренний телефон

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

HTTP-статус: 400

{
            "error": "FIND_SHORT",
            "error_description": "Too short a search phrase."
        }

Название `тип`	Описание
error `string`	Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания
error_description `error_description`	Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Код	Описание	Значение
`FIND_SHORT`	Too short a search phrase	Поисковая фраза не передана или слишком короткая для внутреннего фильтра поиска

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус	Код Текст ошибки	Описание
`500`	`INTERNAL_SERVER_ERROR` Internal server error	Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	Превышен лимит на интенсивность запросов
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	Текущий метод не разрешен для вызова с помощью batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	Превышена максимальная длина параметров, переданных в метод batch
`401`	`NO_AUTH_FOUND` Wrong authorization data	Неверный access-токен или код вебхука
`400`	`INVALID_REQUEST` Https required	Для вызовов методов требуется использовать протокол HTTPS
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	REST API доступен только на коммерческих планах
`403`	`INVALID_CREDENTIALS` Invalid request credentials	У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	Манифест недоступен
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	Запрос требует более высоких привилегий, чем предоставляет токен вебхука
`401`	`expired_token` The access token provided has expired	Предоставленный access-токен доступа истек
`403`	`user_access_error` The user does not have access to the application	Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям
`500`	`PORTAL_DELETED` Portal was deleted	Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Найти подразделения

Добавить запись в историю поиска

Найти пользователей im.search.user.list

Параметры методаПараметры метода

Примеры кодаПримеры кода

Обработка ответаОбработка ответа

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

Объект пользователяОбъект пользователя

Объект phonesОбъект phones

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

Возможные коды ошибокВозможные коды ошибок

Статусы и коды системных ошибокСтатусы и коды системных ошибок

Продолжите изучениеПродолжите изучение