метод REST scope: im

im.user.list.get

Получить данные о списке пользователей

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

Описание

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

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

Параметры

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

Массив идентификаторов пользователей или 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 -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

Ответ

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

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

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

time time

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

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

HTTP-статус: 400

{
    "error": "INVALID_FORMAT",
    "error_description": "A wrong format for the ID field is passed"
}
Код Описание Значение
INVALID_FORMAT A wrong format for the ID field is passed Параметр ID не передан или передан в неверном формате

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

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