Получить список пользователей с поиском по персональным данным user.search

Выберите инструмент для разработки с AI-агентом:

используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: user, user_brief, user_basic

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

Метод user.search ищет пользователей по имени, фамилии, отчеству, названию подразделения и должности.

Перечень полей пользователей Битрикс24, который будет получен в результате выполнения метода, зависит от скоупа приложения/вебхука. Какие поля доступны в каждой версии — в статье Версии скоупа user.

Метод наследует поведение метода user.get, все параметры из этой функции также доступны.

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

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

Название `тип`	Описание
FILTER `object`	Объект с полями поиска (подробное описание)
sort `string`	Поле, по которому сортируются результаты. Сортировка работает по всем полям из user.add. По умолчанию — `ID`
order `string`	Направление сортировки: `ASC` — по возрастанию `DESC` — по убыванию По умолчанию — `ASC`
ADMIN_MODE `boolean`	Включает режим администратора для получения данных о пользователях. Параметр действует, только если запрос выполняет администратор. По умолчанию — `false`
select `array`	Массив с названиями полей, которые вернутся в ответе. Без этого параметра метод возвращает все поля, доступные скоупу приложения или вебхука. При выборке используйте маски: `` — все доступные поля `UF_` — все доступные пользовательские поля, в том числе созданные в Битрикс24 Недоступные скоупу и несуществующие поля метод пропускает без ошибки
start `integer`	Параметр используется для управления постраничной навигацией. Размер страницы результатов всегда статичный: 50 записей. Чтобы выбрать вторую страницу результатов, необходимо передавать значение `50`. Чтобы выбрать третью страницу результатов — значение `100` и так далее. Формула расчета значения параметра `start`: `start = (N - 1) * 50`, где `N` — номер нужной страницы. По умолчанию — `0`

Параметр FILTER

Название `тип`	Описание
FIND `string`	Строка для поиска одновременно по имени, фамилии, отчеству, должности и названию подразделения
NAME `string`	Имя пользователя
LAST_NAME `string`	Фамилия пользователя
SECOND_NAME `string`	Отчество пользователя
WORK_POSITION `string`	Должность пользователя
UF_DEPARTMENT_NAME `string`	Название подразделения
USER_TYPE `string`	Тип пользователя. Возможные значения: `employee` — сотрудник `extranet` — пользователь экстранета `email` — почтовый пользователь

Для поиска сразу по персональным данным передайте только FIND. Для поиска по конкретным полям не передавайте FIND, а укажите одно или несколько полей NAME, LAST_NAME, SECOND_NAME, WORK_POSITION, UF_DEPARTMENT_NAME.

Метод автоматически выбирает полнотекстовый поиск или поиск по началу строки USER_NAME LIKE "Текст%". Поиск по началу строки работает быстрее двухстороннего LIKE "%текст%" и левостороннего LIKE "%текст" за счет индексации полей в базе данных.

Примеры кода

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

cURL (Webhook)

cURL (OAuth)

JS (TS)

JS (UMD)

Python

PHP

BX24.js

PHP CRest

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
    "FILTER": {
        "FIND": "Иван"
    }
}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/user.search

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
    "FILTER": {
        "FIND": "Иван"
    },
    "auth": "**put_access_token_here**"
}' \
https://**put_your_bitrix24_address**/rest/user.search

// 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 object returned in result[]
type UserItem = {
  ID: string
  ACTIVE: boolean
  NAME: string
  LAST_NAME: string
  SECOND_NAME?: string
  EMAIL: string
  LAST_LOGIN: ISODate | ''
  DATE_REGISTER: ISODate | ''
  IS_ONLINE: string
  PERSONAL_BIRTHDAY?: ISODate | ''
  WORK_POSITION?: string
  UF_DEPARTMENT?: number[]
  USER_TYPE: 'employee' | 'extranet' | 'email'
}

try {
  const response = await $b24.actions.v2.call.make<UserItem[]>({
    method: 'user.search',
    params: {
      FILTER: {
        FIND: 'Иван',
      },
    },
    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 found on this page:', result.length, result)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}

<!-- 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 searchUsers() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'user.search',
        params: {
          FILTER: {
            FIND: 'Иван',
          },
        },
        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 found on this page:', result.length, result)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

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

from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.user.search(
        filter={
            "FIND": "Иван",
        },
    ).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}")

try {
    $response = $b24Service
        ->core
        ->call(
            'user.search',
            [
                'FILTER' => [
                    'FIND' => 'Иван',
                ],
            ]
        );

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

    echo 'Success: ' . print_r($result, true);

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

BX24.callMethod(
    "user.search",
    {
        "FILTER": {
            "FIND": "Иван"
        }
    },
    function(result)
    {
        if (result.error())
        {
            console.error(result.error());
            return;
        }

        console.dir(result.data());

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

require_once('crest.php');

$result = CRest::call(
    'user.search',
    [
        "FILTER" => [
            "FIND" => "Иван",
        ],
    ]
);

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

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

HTTP-статус: 200

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

Объект result

Метод возвращает поля, доступные скоупу приложения или вебхука. Полный перечень можно получить методом user.fields.

Название `тип`	Описание
ID `integer`	Идентификатор пользователя
ACTIVE `boolean`	Признак активности пользователя
NAME `string`	Имя пользователя
LAST_NAME `string`	Фамилия пользователя
SECOND_NAME `string`	Отчество пользователя
EMAIL `string`	Адрес электронной почты
LAST_LOGIN `datetime`	Дата и время последней авторизации
DATE_REGISTER `datetime`	Дата и время регистрации
IS_ONLINE `string`	Признак активности пользователя онлайн. Возможные значения: `Y` — пользователь онлайн `N` — пользователь не онлайн
PERSONAL_BIRTHDAY `date`	Дата рождения
WORK_POSITION `string`	Должность
UF_DEPARTMENT `integer[]`	Идентификаторы подразделений пользователя
USER_TYPE `string`	Тип пользователя: `employee`, `extranet` или `email`

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

У метода нет специфичных ошибок.

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

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

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус	Код Текст ошибки	Описание
`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	Превышен лимит на интенсивность запросов
`429`	`OPERATION_TIME_LIMIT` Method is blocked due to operation time limit	Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит
`401`	`NO_AUTH_FOUND` Wrong authorization data	В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука
`401`	`INVALID_REQUEST` Https required	Методы вызываются только по протоколу HTTPS
`401`	`OVERLOAD_LIMIT` REST API is blocked due to overload	REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24
`401`	`ACCESS_DENIED` REST is available only on commercial plans	REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — `REST is available only by subscription`
`401`	`INVALID_CREDENTIALS` Invalid request credentials	Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом
`404`	`ERROR_METHOD_NOT_FOUND` Method not found!	Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа
`401`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на `provided by the access token`
`401`	`expired_token` The access token provided has expired	Срок действия access-токена истек
`401`	`user_access_error` The user does not have access to the application	Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям
`403`	`PORTAL_DELETED` Portal was deleted	Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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

Была ли статья полезна?

Получить список пользователей по фильтру

Получить поля пользователя

Получить список пользователей с поиском по персональным данным user.search

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

Параметр FILTERПараметр FILTER

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

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

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

Объект resultОбъект result

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

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

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