# user.get

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

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

## Описание

Метод `user.get` позволяет получить фильтрованный список пользователей. Метод возвращает всех пользователей за исключением: ботов, пользователей для e-mail, пользователей для Открытых Линий, пользователей Реплики.

По умолчанию метод сортирует пользователей по возрастанию `ID`.

Метод не возвращает интеграторов. Перечень полей пользователей Битрикс24, который будет получен в результате выполнения метода, зависит от скоупа приложения/вебхука. Какие поля доступны в каждой версии — в статье [Версии скоупа user](https://apidocs.bitrix24.ru/api-reference/user/user-scope.html).

## Параметры

- `sort` `string` — необязательный. Поле, по которому сортируются результаты. Сортировка работает по всем полям из [user.add](https://chugunov.pro/api-bitrix24/user/user-add/)
- `order` `string` — необязательный. Направление сортировки:
  - `ASC` — по возрастанию
  - `DESC` — по убыванию
- `FILTER` `string` — необязательный. Дополнительно можно указывать любые параметры из [user.add](https://chugunov.pro/api-bitrix24/user/user-add/) для фильтрации по их значениям. Кроме основных полей, доступны дополнительные:
  - `UF_DEPARTMENT` — принадлежность к структуре компании;
  - `UF_PHONE_INNER` — внутренний телефонный номер;
  - `IS_ONLINE` — [Y|N] позволяет показать только авторизованных или нет пользователей.
  - `NAME_SEARCH` — быстрый поиск по персональным данным.
  - `USER_TYPE` — тип пользователя. Может принимать следующие значения: 
      - `employee` — сотрудник, 
      - `extranet` — пользователь экстранета, 
      - `email` — почтовый пользователь
  - `ACTIVE` — при значении *true* исключает из запроса уволенных пользователей.
    
  Параметры фильтрации могут принимать значение массивов.
  Ключу может быть задан дополнительный префикс, уточняющий поведение фильтра. Возможные значения префикса:
  - `>=` — больше либо равно
  - `>` — больше
  - `<=` — меньше либо равно
  - `<` — меньше
  - `@` — IN (в качестве значения передаётся массив)
  - `!@`— NOT IN (в качестве значения передаётся массив)
  - `%` — LIKE, поиск по подстроке. Символ `%` в значении фильтра передавать не нужно. Поиск ищет подстроку в любой позиции строки
  - `=%` — LIKE, поиск по подстроке. Символ `%` нужно передавать в значении. Примеры:
      - "мол%" — ищем значения, начинающиеся с «мол»
      - "%мол" — ищем значения, заканчивающиеся на «мол»
      - "%мол%" — ищем значения, где «мол» может быть в любой позиции
  - `%=` — LIKE (см. описание выше)
  - `!%` — NOT LIKE, поиск по подстроке. Символ `%` в значении фильтра передавать не нужно. Поиск идет с обоих сторон.
  - `!=%` — NOT LIKE, поиск по подстроке. Символ `%` нужно передавать в значении. Примеры:
      - "мол%" — ищем значения, не начинающиеся с «мол»
      - "%мол" — ищем значения, не заканчивающиеся на «мол»
      - "%мол%" — ищем значения, где подстроки «мол» нет в любой позиции
  - `!%=` — NOT LIKE (см. описание выше)
  - `=` — равно, точное совпадение (используется по умолчанию)
  - `!=` - не равно
  - `!` — не равно
  Значения полей с датой и временем передавайте в формате ISO 8601, например `2020-01-01T00:00:00+03:00`, или в формате даты вашего Битрикс24. Это относится к полям `TIMESTAMP_X`, `DATE_REGISTER`, `LAST_LOGIN`, `LAST_ACTIVITY_DATE`, `PERSONAL_BIRTHDAY`, `UF_EMPLOYMENT_DATE` и к пользовательским полям типа дата и дата со временем. Если значение не распознано как дата, условие не отберет ни одной записиы
- `ADMIN_MODE` `boolean` — необязательный. [Ключ для работы](*ключ_Ключ для работы) в режиме администратора. Служит для получения данных о любых пользователях
- `select` `array` — необязательный. Массив с названиями полей, которые вернутся в ответе. Без этого параметра метод возвращает все поля, доступные скоупу приложения или вебхука.
  При выборке используйте маски:
  - `*` — все доступные поля
  - `UF_*` — все доступные пользовательские поля, в том числе созданные в Битрикс24
  Недоступные скоупу и несуществующие поля метод пропускает без ошибки
- `IMAGE_RESIZE` `string` — необязательный. Размер копии фотографии в поле `PERSONAL_PHOTO`:
  - `small` — 150 × 150 пикселей
  - `medium` — 300 × 300 пикселей
  - `large` — 1000 × 1000 пикселей
  Без этого параметра метод возвращает ссылку на исходное изображение
- `start` `integer` — необязательный. Параметр используется для управления постраничной навигацией.
  Размер страницы результатов всегда статичный: 50 записей.
  Чтобы выбрать вторую страницу результатов, необходимо передавать значение `50`. Чтобы выбрать третью страницу результатов — значение `100` и так далее.
  Формула расчета значения параметра `start`:
  `start = (N-1) * 50`, где `N` — номер нужной страницы

## Ответ

HTTP-статус: 200

```json
{
    "result": [
        {
            "ID": "1",
            "ACTIVE": true,
            "NAME": "Вадим",
            "LAST_NAME": "Валеев",
            "SECOND_NAME": "",
            "EMAIL": "v.r.valeev@bitrix.com",
            "LAST_LOGIN": "2024-07-25T13:06:54+00:00",
            "DATE_REGISTER": "2024-07-15T00:00:00+00:00",
            "TIME_ZONE": "",
            "IS_ONLINE": "Y",
            "TIMESTAMP_X": {
            },
            "LAST_ACTIVITY_DATE": {
            },
            "PERSONAL_GENDER": "",
            "PERSONAL_WWW": "",
            "PERSONAL_BIRTHDAY": "2018-07-14T00:00:00+00:00",
            "PERSONAL_MOBILE": "",
            "PERSONAL_CITY": "",
            "WORK_PHONE": "",
            "WORK_POSITION": "",
            "UF_EMPLOYMENT_DATE": "",
            "UF_DEPARTMENT": [1],
            "USER_TYPE": "employee"
        },
        {
            "ID": "3",
            "ACTIVE": true,
            "NAME": "Иван",
            "LAST_NAME": "Иванов",
            "EMAIL": "test@gmail.com",
            "LAST_LOGIN": "2024-07-24T09:01:55+00:00",
            "DATE_REGISTER": "2024-07-22T00:00:00+00:00",
            "IS_ONLINE": "N",
            "TIMESTAMP_X": {
            },
            "LAST_ACTIVITY_DATE": {
            },
            "PERSONAL_GENDER": "",
            "PERSONAL_BIRTHDAY": "",
            "WORK_POSITION": "",
            "UF_EMPLOYMENT_DATE": "",
            "UF_DEPARTMENT": [1],
            "USER_TYPE": "employee"
        }
    ],
    "total": 2,
    "time": {
        "start": 1721913235.39648,
        "finish": 1721913235.45078,
        "duration": 0.05430006980896,
        "processing": 0.0187909603118897,
        "date_start": "2024-07-25T13:13:55+00:00",
        "date_finish": "2024-07-25T13:13:55+00:00",
        "operating": 0
    }
}
```

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

- `result` `object`. Корневой элемент ответа, который содержит отфильтрованный список пользователей
- `total` `integer`. Общее количество найденных записей
- `time` `time`. Информация о времени выполнения запроса

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

### cURL (Webhook)

```curl
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
    "UF_DEPARTMENT": 1,
    "SORT": "ID",
    "ORDER": "asc",
    "start": 10
}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/user.get
```

### cURL (OAuth)

```curl
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
    "UF_DEPARTMENT": 1,
    "SORT": "ID",
    "ORDER": "asc",
    "start": 10,
    "auth": "**put_access_token_here**"
}' \
https://**put_your_bitrix24_address**/rest/user.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

type UserData = {
  ID: string
  ACTIVE: boolean
  NAME: string
  LAST_NAME: string
  SECOND_NAME: string
  EMAIL: string
  LAST_LOGIN: ISODate | ''
  DATE_REGISTER: ISODate | ''
  TIME_ZONE: string
  IS_ONLINE: string
  PERSONAL_GENDER: string
  PERSONAL_BIRTHDAY: ISODate | ''
  PERSONAL_CITY: string
  WORK_PHONE: string
  WORK_POSITION: string
  UF_EMPLOYMENT_DATE: string
  UF_DEPARTMENT: number[]
  USER_TYPE: string
}

try {
  // user.get returns a single page (max 50 records). For the whole result set
  // use a list helper: $b24.actions.v2.callList.make() returns every record as one
  // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
  // NOTE: the list helpers do not accept `order` (it is excluded from their params, so
  // passing it is a TS error) — keep this call.make + `start` variant when sort matters.
  const response = await $b24.actions.v2.call.make<UserData[]>({
    method: 'user.get',
    params: {
      UF_DEPARTMENT: 1,
      SORT: 'ID',
      ORDER: 'asc',
      start: 10,
    },
    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(`Fetched ${result.length} users:`, result.map(u => `${u.NAME} ${u.LAST_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 getUsers() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      // user.get returns a single page (max 50 records). For the whole result set
      // use a list helper: $b24.actions.v2.callList.make() returns every record as one
      // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
      // NOTE: the list helpers do not accept `order` (it is excluded from their params, so
      // passing it is a TS error) — keep this call.make + `start` variant when sort matters.
      const response = await $b24.actions.v2.call.make({
        method: 'user.get',
        params: {
          UF_DEPARTMENT: 1,
          SORT: 'ID',
          ORDER: 'asc',
          start: 10,
        },
        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(`Fetched ${result.length} users:`, result.map(u => `${u.NAME} ${u.LAST_NAME}`))
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

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

### Python

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

try:
    bitrix_response = client.user.get(
        filter={
            "UF_DEPARTMENT": 1,
        },
        sort="ID",
        order="asc",
        start=10,
    ).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(
            'user.get',
            [
                'UF_DEPARTMENT' => 1,
                'SORT'         => 'ID',
                'ORDER'        => 'asc',
                'start'        => 10,
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    if ($result->error()) {
        error_log($result->error());
    } else {
        echo 'Success: ' . print_r($result->data(), true);
    }

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error getting users: ' . $e->getMessage();
}
```

### BX24.js

```js
BX24.callMethod(
    "user.get",
    {
        "UF_DEPARTMENT": 1,
        "SORT": "ID",
        "ORDER": "asc"
    },
    function(result)
    {
        if (result.error())
        {
            console.error(result.error());
            return;
        }

        console.dir(result.data());

        if (result.more())
        {
            result.next();
        }
    }
);
```

### PHP CRest

```php
require_once('crest.php');

$result = CRest::call(
    'user.get',
    [
        "UF_DEPARTMENT" => 1,
        "SORT" => 'ID',
        "ORDER" => 'asc',
        "start" => 10
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
```

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