# im.user.list.get

URL: https://chugunov.pro/api-bitrix24/chats/users/im-user-list-get/
Проверено на Битрикс24 REST API, обновлено 11.09.2026 (ревизия источника fb39d6c).
Источник: официальная документация Битрикс24 (bitrix-tools/b24-rest-docs, лицензия MIT, © Bitrix). Справочник независимый, официальной документацией не является.

Получить данные о списке пользователей
Scope: `im`
Кто может выполнять метод: любой пользователь

## Описание

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

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

## Параметры

- `ID` `array` — обязательный. Массив идентификаторов пользователей или JSON-строка с массивом.
  Получить идентификаторы пользователей можно методами [user.get](https://chugunov.pro/api-bitrix24/user/user-get/), [user.search](https://chugunov.pro/api-bitrix24/user/user-search/) или [im.chat.user.list](https://chugunov.pro/api-bitrix24/chats/chat-users/im-chat-user-list/)
- `AVATAR_HR` `string` — необязательный. Параметр для запроса поля `avatar_hr` с адресом аватара в высоком разрешении. Допустимые значения: `Y` или `N`, по умолчанию `N`.
  На текущий момент поле `avatar_hr` возвращается всегда, независимо от значения параметра
- `RESULT_TYPE` `string` — необязательный. Формат `result`. Значение `array` вернет обычный массив объектов пользователей, любое другое значение вернет объект с ключами-идентификаторами пользователей

## Ответ

HTTP-статус: 200

```json
{
    "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'` возвращается массив.
  Структура объекта пользователя подробно описана [ниже](#user-object)
- `time` `time`. Информация о времени выполнения запроса

## Ошибки

HTTP-статус: 400

```json
{
    "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` не передан или передан в неверном формате

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

### cURL (Webhook)

```bash
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 (OAuth)

```bash
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
```

### JS (TS)

```ts
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame, ISODate } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

// Shape of each user returned in result[] (match the "response handling" section of the page)
type ImUserInfo = {
  id: number
  active: boolean
  name: string
  first_name: string
  last_name: string
  work_position: string
  color: string
  avatar: string
  avatar_hr: string
  gender: string
  birthday: string
  extranet: boolean
  network: boolean
  bot: boolean
  connector: boolean
  external_auth_id: string
  status: string
  idle: ISODate | false
  last_activity_date: ISODate
  mobile_last_date: ISODate | false
  desktop_last_date: ISODate | false
  absent: ISODate | false
  departments: number[]
  phones: { work_phone: string; personal_mobile: string; inner_phone: string } | false
  website: string
  email: string
  bot_data: object | null
  type: string
}

try {
  const response = await $b24.actions.v2.call.make<ImUserInfo[]>({
    method: 'im.user.list.get',
    params: {
      ID: [4, 5],
      AVATAR_HR: 'Y',
      RESULT_TYPE: 'array',
    },
    requestId: Text.getUuidRfc4122()
  })

  // The payload is available only on a successful response
  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info('Users:', result.length, result.map(u => u.name))
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}
```

### JS (UMD)

```html
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function getImUserList() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'im.user.list.get',
        params: {
          ID: [4, 5],
          AVATAR_HR: 'Y',
          RESULT_TYPE: 'array',
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

      // The payload is available only on a successful response
      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info('Users:', result.length, result.map(u => u.name))
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', getImUserList)
</script>
```

### Python

```python
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.im.user.list.get(
        bitrix_id=[
            4,
            5,
        ],
        avatar_hr=True,
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")
```

### PHP

```php
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.js

```js
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());
        }
    }
);
```

### PHP CRest

```php
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']);
}
```

### Go

```go
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "im.user.list.get", b24.Params{
	"ID":          []int{4, 5},
	"AVATAR_HR":   "Y",
	"RESULT_TYPE": "array",
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("im.user.list.get: %w", err)
}

var items []struct {
	ID           b24.ID `json:"id"`
	Active       bool   `json:"active"`
	Name         string `json:"name"`
	FirstName    string `json:"first_name"`
	LastName     string `json:"last_name"`
	WorkPosition string `json:"work_position"`
}
if err := json.Unmarshal(res.Result, &items); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
for _, it := range items {
	fmt.Println(it.ID, it.Active)
}
```

Оригинал в официальной документации: https://apidocs.bitrix24.ru/api-reference/chats/users/im-user-list-get.html