Найти подразделения im.search.department.list

Scope: im

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

Метод im.search.department.list выполняет поиск подразделений по полному названию.

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

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

Название `Тип`	Описание
FIND* `string`	Поисковая фраза для поиска по полному названию подразделения (поле full_name)
USER_DATA `string`	Возвращать данные руководителя подразделения в поле manager_user_data. Доступные значения: `Y` — да `N` — нет Значение по умолчанию — `N`
OFFSET `integer`	Смещение выборки подразделений. По умолчанию `0`
LIMIT `integer`	Количество элементов в выборке. По умолчанию `10`. Максимальное значение `50`

Примеры кода

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

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"FIND":"Отдел","USER_DATA":"Y","OFFSET":0,"LIMIT":10}' \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/im.search.department.list

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"FIND":"Отдел","USER_DATA":"Y","OFFSET":0,"LIMIT":10,"auth":"**put_access_token_here**"}' \
          https://**put_your_bitrix24_address**/rest/im.search.department.list

try {
          const response = await $b24.callMethod('im.search.department.list', {
            FIND: 'Отдел',
            USER_DATA: 'Y',
            OFFSET: 0,
            LIMIT: 10,
          });
        
          const { result, total, next } = response.getData();
          console.log(result, total, next);
        } catch (error) {
          console.error(error);
        }

try {
            $response = $b24Service->core->call(
                'im.search.department.list',
                [
                    'FIND' => 'Отдел',
                    'USER_DATA' => 'Y',
                    '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.department.list',
            {
                FIND: 'Отдел',
                USER_DATA: 'Y',
                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.department.list',
            [
                'FIND' => 'Отдел',
                'USER_DATA' => 'Y',
                'OFFSET' => 0,
                'LIMIT' => 10,
            ]
        );
        
        if (!empty($result['error'])) {
            echo 'Error: ' . $result['error_description'];
        } else {
            var_dump($result['result']);
        }

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

HTTP-код: 200

{
            "result": [
                {
                    "id": 9,
                    "name": "Отдел маркетинга и рекламы",
                    "full_name": "Отдел маркетинга и рекламы / Моя компания",
                    "manager_user_id": 3,
                    "manager_user_data": {
                        "id": 3,
                        "active": true,
                        "name": "Елена Иванова",
                        "first_name": "Елена",
                        "last_name": "Иванова",
                        "work_position": "",
                        "color": "#1eb4aa",
                        "avatar": "https://example.bitrix24.ru/upload/main/avatar.png",
                        "avatar_hr": "https://example.bitrix24.ru/upload/main/avatar.png",
                        "gender": "F",
                        "birthday": "06-04",
                        "extranet": false,
                        "network": false,
                        "bot": false,
                        "connector": false,
                        "external_auth_id": "socservices",
                        "status": "online",
                        "idle": false,
                        "last_activity_date": "2026-03-04T22:08:29+03:00",
                        "mobile_last_date": false,
                        "desktop_last_date": false,
                        "absent": false,
                        "departments": [1],
                        "phones": {
                            "work_phone": "7495111111",
                            "inner_phone": "222"
                        },
                        "bot_data": null,
                        "type": "user",
                        "website": "example.ru",
                        "email": "user@example.ru"
                    }
                },
                ... // описание для каждого подразделения
            ],
            "total": 2,
            "time": {
                "start": 1772651443,
                "finish": 1772651443.378436,
                "duration": 0.3784360885620117,
                "processing": 0,
                "date_start": "2026-03-04T22:10:43+03:00",
                "date_finish": "2026-03-04T22:10:43+03:00",
                "operating_reset_at": 1772652043,
                "operating": 0
            }
        }

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

Название `Тип`	Описание
result `array`	Список найденных подразделений. Структура объекта подразделения подробно описана ниже
total `integer`	Общее количество найденных подразделений
next `integer`	Смещение следующей страницы. Поле возвращается, если есть следующая страница
time `time`	Информация о времени выполнения запроса

Объект подразделения

Название `Тип`	Описание
id `integer`	Идентификатор подразделения
name `string`	Короткое название подразделения
full_name `string`	Полное название подразделения
manager_user_id `integer`	Идентификатор руководителя подразделения
manager_user_data `object`	Данные руководителя подразделения. Объект возвращается только при `USER_DATA = 'Y'`. Структура объекта руководителя подробно описана ниже

Объект manager_user_data

Название `Тип`	Описание
id `integer`	Идентификатор пользователя
active `boolean`	Признак активности учетной записи пользователя
name `string`	Имя и фамилия пользователя
first_name `string`	Имя пользователя
last_name `string`	Фамилия пользователя
work_position `string`	Должность пользователя
color `string`	Цвет пользователя в формате HEX
avatar `string` `null`	Ссылка на аватар пользователя
avatar_hr `string` `null`	Ссылка на аватар высокого разрешения. На текущий момент поле возвращается всегда, независимо от значения `AVATAR_HR`
gender `string`	Пол пользователя: `M`, `F` или пустое значение, если не указан
birthday `string`	День рождения в формате `DD-MM` или пустая строка
extranet `boolean`	Признак экстранет-пользователя
network `boolean`	Признак пользователя Битрикс24 Network
bot `boolean`	Признак пользователя-бота
connector `boolean`	Признак пользователя-коннектора открытых линий
external_auth_id `string`	Идентификатор внешней авторизации
status `string`	Статус пользователя. В новом мессенджере поле всегда содержит `online` независимо от фактически установленного статуса. Проверить установленный статус можно методом im.user.status.get, изменить — методом im.user.status.set
idle `string` `boolean`	Время перехода в статус «Отошел» в формате ISO 8601 (RFC3339) или `false`
last_activity_date `string` `boolean`	Время последней активности в формате ISO 8601 (RFC3339) или `false`
mobile_last_date `string` `boolean`	Время последней активности в мобильном приложении в формате ISO 8601 (RFC3339) или `false`
desktop_last_date `string` `boolean`	Время последней активности в десктопном приложении в формате ISO 8601 (RFC3339) или `false`
absent `string` `boolean`	Дата окончания отсутствия в формате ISO 8601 (RFC3339) или `false`
departments `array`	Массив идентификаторов подразделений
phones `object` `boolean`	Телефоны пользователя или `false`. Структура объекта подробно описана ниже
website `string`	Сайт пользователя или пустая строка
email `string`	Email пользователя или пустая строка
bot_data `object` `null`	Данные бота для пользователей-ботов
type `string`	Тип пользователя

Объект phones

Название `Тип`	Описание
personal_mobile `string`	Мобильный телефон
work_phone `string`	Рабочий телефон
inner_phone `string`	Внутренний телефон

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

HTTP-статус: 400

{
            "error": "FIND_SHORT",
            "error_description": "Too short a search phrase."
        }

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

Возможные коды ошибок

Код	Описание	Значение
`FIND_SHORT`	Too short a search phrase	Не передан параметр `FIND` или фраза меньше трех символов

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

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

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

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

Найти чаты по названиям

Найти пользователей

Найти подразделения im.search.department.list

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

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

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

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

Объект подразделенияОбъект подразделения

Объект manager_user_dataОбъект manager_user_data

Объект phonesОбъект phones

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

Возможные коды ошибокВозможные коды ошибок

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

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