Получить данные о списке пользователей im.user.list.get

Scope: im

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

Метод im.user.list.get возвращает данные о пользователях по списку идентификаторов.

Если текущий пользователь является экстранет-пользователем, метод вернет данные только по пользователям из его экстранет-групп. Идентификаторы пользователей вне этих групп будут пропущены без ошибки.

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

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

Название `Тип`	Описание
ID* `array` `string`	Массив идентификаторов пользователей или JSON-строка с массивом. Получить идентификаторы пользователей можно методами user.get, user.search или im.chat.user.list
AVATAR_HR `string`	Параметр для запроса поля `avatar_hr` с адресом аватара в высоком разрешении. Допустимые значения: `Y` или `N`, по умолчанию `N`. На текущий момент поле `avatar_hr` возвращается всегда, независимо от значения параметра
RESULT_TYPE `string`	Формат `result`. Значение `array` вернет обычный массив объектов пользователей, любое другое значение вернет объект с ключами-идентификаторами пользователей

Примеры кода

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

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"ID":[4,5],"AVATAR_HR":"Y","RESULT_TYPE":"array"}' \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/im.user.list.get

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"ID":[4,5],"RESULT_TYPE":"array","auth":"**put_access_token_here**"}' \
          https://**put_your_bitrix24_address**/rest/im.user.list.get

try {
          const response = await $b24.callMethod('im.user.list.get', {
            ID: [4, 5],
            AVATAR_HR: 'Y',
            RESULT_TYPE: 'array',
          });
        
          const { result } = response.getData();
          console.log(result);
        } catch (error) {
          console.error(error);
        }

try {
            $response = $b24Service->core->call(
                'im.user.list.get',
                [
                    'ID' => [4, 5],
                    'AVATAR_HR' => 'Y',
                    'RESULT_TYPE' => 'array',
                ]
            );
        
            $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.user.list.get',
            {
                ID: [4, 5],
                AVATAR_HR: 'Y',
                RESULT_TYPE: 'array',
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error().ex);
                } else {
                    console.log(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'im.user.list.get',
            [
                'ID' => [4, 5],
                'AVATAR_HR' => 'Y',
                'RESULT_TYPE' => 'array',
            ]
        );
        
        if (!empty($result['error'])) {
            echo 'Error: ' . $result['error_description'];
        } else {
            var_dump($result['result']);
        }

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

HTTP-код: 200

{
            "result": [
                {
                    "id": 4,
                    "active": true,
                    "name": "Анна Соколова",
                    "first_name": "Анна",
                    "last_name": "Соколова",
                    "work_position": "Аналитик",
                    "color": "#df532d",
                    "avatar": "https://example.bitrix24.ru/upload/main/avatar4.png",
                    "avatar_hr": "https://example.bitrix24.ru/upload/main/avatar4_hr.png",
                    "gender": "F",
                    "birthday": "",
                    "extranet": false,
                    "network": false,
                    "bot": false,
                    "connector": false,
                    "external_auth_id": "default",
                    "status": "online",
                    "idle": false,
                    "last_activity_date": "2026-03-02T09:30:00+03:00",
                    "mobile_last_date": false,
                    "desktop_last_date": false,
                    "absent": false,
                    "departments": [7, 5],
                    "phones": {
                        "work_phone": "+71234567891",
                        "personal_mobile": "+71234567891",
                        "inner_phone": "22"
                    },
                    "website": "example.ru",
                    "email": "anna.sokolova@example.ru",
                    "bot_data": null,
                    "type": "user"
                },
                {
                    "id": 5,
                    "active": true,
                    "name": "Иван Петров",
                    "first_name": "Иван",
                    "last_name": "Петров",
                    "work_position": "Менеджер",
                    "color": "#048bd0",
                    "avatar": "https://example.bitrix24.ru/upload/main/avatar.png",
                    "avatar_hr": "https://example.bitrix24.ru/upload/main/avatar_hr.png",
                    "gender": "M",
                    "birthday": "",
                    "extranet": false,
                    "network": false,
                    "bot": false,
                    "connector": false,
                    "external_auth_id": "default",
                    "status": "online",
                    "idle": false,
                    "last_activity_date": "2026-03-02T09:30:00+03:00",
                    "mobile_last_date": false,
                    "desktop_last_date": false,
                    "absent": false,
                    "departments": [10],
                    "phones": {
                        "work_phone": "+71234567890",
                        "personal_mobile": "+71234567890",
                        "inner_phone": "21"
                    },
                    "website": "example.ru",
                    "email": "user@example.ru",
                    "bot_data": null,
                    "type": "user"
                }
            ],
            "time": {
                "start": 1772449081,
                "finish": 1772449081.887056,
                "duration": 0.8870561122894287,
                "processing": 0,
                "date_start": "2026-03-02T13:58:01+03:00",
                "date_finish": "2026-03-02T13:58:01+03:00",
                "operating_reset_at": 1772449681,
                "operating": 0
            }
        }

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

Название
Тип

Описание

result
object
array

Данные пользователей. По умолчанию возвращается объект с ключами-идентификаторами, при RESULT_TYPE = 'array' возвращается массив.

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

time
time

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

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

Название `Тип`	Описание
id `integer`	Идентификатор пользователя
active `boolean`	Признак активности учетной записи пользователя
name `string`	Имя и фамилия пользователя
first_name `string`	Имя пользователя
last_name `string`	Фамилия пользователя
work_position `string`	Должность пользователя
color `string`	Цвет пользователя в формате HEX
avatar `string` `null`	Ссылка на аватар пользователя
avatar_hr `string` `null`	Ссылка на аватар высокого разрешения. На текущий момент поле возвращается всегда, независимо от значения `AVATAR_HR`
gender `string`	Пол пользователя: `M`, `F` или пустое значение, если не указан
birthday `string`	День рождения в формате `DD-MM` или пустая строка
extranet `boolean`	Признак экстранет-пользователя
network `boolean`	Признак пользователя Битрикс24 Network
bot `boolean`	Признак пользователя-бота
connector `boolean`	Признак пользователя-коннектора открытых линий
external_auth_id `string`	Идентификатор внешней авторизации
status `string`	Статус пользователя. В новом мессенджере поле всегда содержит `online` независимо от фактически установленного статуса. Проверить установленный статус можно методом im.user.status.get, изменить — методом im.user.status.set
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`
desktop_last_date `string` `boolean`	Время последней активности в десктопном приложении в формате ISO 8601 (RFC3339) или `false`
absent `string` `boolean`	Дата окончания отсутствия в формате ISO 8601 (RFC3339) или `false`
departments `array`	Массив идентификаторов подразделений
phones `object` `boolean`	Телефоны пользователя или `false`. Структура объекта подробно описана ниже
website `string`	Сайт пользователя или пустая строка
email `string`	Email пользователя или пустая строка
bot_data `object` `null`	Данные бота для пользователей-ботов
type `string`	Тип пользователя

Объект phones

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

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

HTTP-статус: 400

{
            "error": "INVALID_FORMAT",
            "error_description": "A wrong format for the ID field is passed"
        }

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

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

Код	Описание	Значение
`INVALID_FORMAT`	A wrong format for the ID field is passed	Параметр `ID` не передан или передан в неверном формате

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

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.user.list.get

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

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

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

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

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

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

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

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

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

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