Найти пользователей im.search.user.list
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
imКто может выполнять метод: любой пользователь
Метод im.search.user.list выполняет поиск пользователей по имени, фамилии, должности и подразделению.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
FIND* |
Поисковая фраза. Минимальное количество символов для поиска — |
|
BUSINESS |
Искать только среди бизнес-пользователей. Допустимые значения:
Значение по умолчанию — |
|
OFFSET |
Смещение выборки пользователей. По умолчанию |
|
LIMIT |
Количество элементов в выборке. По умолчанию |
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"FIND":"Иван","BUSINESS":"N","OFFSET":0,"LIMIT":10}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/im.search.user.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"FIND":"Иван","BUSINESS":"N","OFFSET":0,"LIMIT":10,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/im.search.user.list
// 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[]
type UserResult = {
id: number
name: string
first_name: string
last_name: string
work_position: string
color: string
avatar: string | null
gender: string
birthday: string | false
extranet: boolean
network: boolean
bot: boolean
connector: boolean
external_auth_id: string
status: string
idle: ISODate | false
last_activity_date: ISODate | false
mobile_last_date: ISODate | false
departments: number[]
absent: ISODate | false
phones: {
work_phone: string
personal_mobile: string
inner_phone: string
} | false
}
try {
// im.search.user.list 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<UserResult[]>({
method: 'im.search.user.list',
params: {
FIND: 'Ivan',
BUSINESS: 'N',
OFFSET: 0,
LIMIT: 10,
start: 0,
},
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('Found users:', result.length, result[0]?.name)
}
} 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 searchUserList() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
// im.search.user.list 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: 'im.search.user.list',
params: {
FIND: 'Ivan',
BUSINESS: 'N',
OFFSET: 0,
LIMIT: 10,
start: 0,
},
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('Found users:', result.length, result[0]?.name)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', searchUserList)
</script>
try {
$response = $b24Service->core->call(
'im.search.user.list',
[
'FIND' => 'Иван',
'BUSINESS' => 'N',
'OFFSET' => 0,
'LIMIT' => 10,
]
);
$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.search.user.list',
{
FIND: 'Иван',
BUSINESS: 'N',
OFFSET: 0,
LIMIT: 10,
},
function(result) {
if (result.error()) {
console.error(result.error().ex);
} else {
console.log(result.data(), result.total(), result.next());
}
}
);
require_once('crest.php');
$result = CRest::call(
'im.search.user.list',
[
'FIND' => 'Иван',
'BUSINESS' => 'N',
'OFFSET' => 0,
'LIMIT' => 10,
]
);
if (!empty($result['error'])) {
echo 'Error: ' . $result['error_description'];
} else {
var_dump($result['result']);
}
Обработка ответа
HTTP-код: 200
{
"result": [
{
"id": 103,
"name": "Светлана Иванова",
"first_name": "Светлана",
"last_name": "Иванова",
"work_position": "Руководитель ИТ-отдела",
"color": "#4ba984",
"avatar": "https://example.bitrix24.ru/upload/main/avatar.png",
"gender": "F",
"birthday": "08-03",
"extranet": false,
"network": false,
"bot": false,
"connector": false,
"external_auth_id": "socservices",
"status": "online",
"idle": false,
"last_activity_date": "2026-03-04T15:40:56+03:00",
"mobile_last_date": false,
"departments": [1, 7],
"absent": false,
"phones": {
"work_phone": "79123456789",
"personal_mobile": "81234567890",
"inner_phone": "78"
}
},
... // описание для каждого пользователя
],
"total": 2,
"time": {
"start": 1772628089,
"finish": 1772628089.061656,
"duration": 0.06165599822998047,
"processing": 0,
"date_start": "2026-03-04T15:41:29+03:00",
"date_finish": "2026-03-04T15:41:29+03:00",
"operating_reset_at": 1772628689,
"operating": 0
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Список найденных пользователей. Структура объекта пользователя подробно описана ниже |
|
total |
Общее количество найденных пользователей |
|
next |
Смещение следующей страницы. Поле возвращается, если есть следующая страница |
|
time |
Информация о времени выполнения запроса |
Объект пользователя
|
Название |
Описание |
|
id |
Идентификатор пользователя |
|
name |
Имя и фамилия пользователя |
|
first_name |
Имя пользователя |
|
last_name |
Фамилия пользователя |
|
work_position |
Должность пользователя |
|
color |
Цвет пользователя в формате HEX |
|
Ссылка на аватар пользователя |
|
|
gender |
Пол пользователя: |
|
День рождения в формате |
|
|
extranet |
Признак экстранет-пользователя |
|
network |
Признак пользователя Bitrix24 Network |
|
bot |
Признак пользователя-бота |
|
connector |
Признак пользователя-коннектора открытых линий |
|
external_auth_id |
Идентификатор внешней авторизации |
|
status |
Текущий статус пользователя |
|
Время перехода в статус «Отошел» в формате ISO 8601 (RFC3339) или |
|
|
Время последней активности в формате ISO 8601 (RFC3339) или |
|
|
Время последней мобильной активности в формате ISO 8601 (RFC3339) или |
|
|
departments |
Массив идентификаторов подразделений |
|
Дата окончания отсутствия в формате ISO 8601 (RFC3339) или |
|
|
phones |
Телефоны пользователя или Структура объекта подробно описана ниже |
Объект phones
|
Название |
Описание |
|
work_phone |
Рабочий телефон |
|
personal_mobile |
Мобильный телефон |
|
inner_phone |
Внутренний телефон |
Обработка ошибок
HTTP-статус: 400
{
"error": "FIND_SHORT",
"error_description": "Too short a search phrase."
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
Значение |
|
|
Too short a search phrase |
Поисковая фраза не передана или слишком короткая для внутреннего фильтра поиска |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |