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

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

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

Scope: im

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

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

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

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

Название
тип

Описание

FIND*
string

Поисковая фраза для поиска по началу слов в полном названии подразделения (поле full_name).

Если параметр не передать, метод вернет ошибку FIND_SHORT. Пустая или очень короткая фраза ошибки не вызывает: фильтр отключается и метод отдает весь список подразделений

USER_DATA
string

Возвращать данные руководителя подразделения в поле manager_user_data.

Доступные значения:

  • Y — да
  • N — нет

Значение по умолчанию — N

OFFSET
integer

Смещение выборки подразделений. По умолчанию 0

LIMIT
integer

Количество элементов в выборке. По умолчанию 10. Максимальное значение 50

Примеры кода

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

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
// 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 ManagerUserData = {
  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; inner_phone?: string } | false
  bot_data: object | null
  type: string
  website: string
  email: string
}

// Shape of each department item returned in result[]
type DepartmentItem = {
  id: number
  name: string
  full_name: string
  manager_user_id: number
  manager_user_data?: ManagerUserData
}

try {
  // im.search.department.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<DepartmentItem[]>({
    method: 'im.search.department.list',
    params: {
      FIND: 'Department',
      USER_DATA: 'Y',
      OFFSET: 0,
      LIMIT: 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('Found departments:', 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 searchDepartmentList() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      // im.search.department.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.department.list',
        params: {
          FIND: 'Department',
          USER_DATA: 'Y',
          OFFSET: 0,
          LIMIT: 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('Found departments:', result.length, result)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', searchDepartmentList)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.im.search.department.list(
        find="отдел",
        user_data=True,
        offset=0,
        limit=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}")
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']);
}
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "im.search.department.list", b24.Params{
	"FIND":      "Отдел",
	"USER_DATA": "Y",
	"OFFSET":    0,
	"LIMIT":     10,
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("im.search.department.list: %w", err)
}

// Ответ приходит как json.RawMessage — разберите его
// в структуру под форму ответа, показанную ниже на этой странице.
fmt.Printf("%s\n", res.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

Информация о времени выполнения запроса

Объект department

Название
тип

Описание

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

Ссылка на аватар

avatar_hr
string

Ссылка на аватар высокого разрешения

gender
string

Пол пользователя

birthday
string

День рождения в формате DD-MM или пустая строка

extranet
boolean

Признак внешнего пользователя

network
boolean

Признак пользователя Битрикс24 Network

bot
boolean

Признак бота

connector
boolean

Признак пользователя открытых линий

external_auth_id
string

Код внешней авторизации

status
string

Статус пользователя

idle
datetime

Дата бездействия пользователя или false

last_activity_date
datetime

Дата последней активности пользователя

mobile_last_date
datetime

Дата последней активности в мобильном приложении или false

desktop_last_date
datetime

Дата последней активности в десктопном приложении или false

absent
datetime

Дата окончания отсутствия пользователя или false

departments
array

Массив идентификаторов подразделений

phones
object

Телефоны пользователя или false (подробное описание)

bot_data
object

Данные бота или null

type
string

Тип пользователя

website
string

Сайт пользователя

email
string

Email пользователя

Объект phones

Название
тип

Описание

work_phone
string

Рабочий телефон

personal_mobile
string

Мобильный телефон

inner_phone
string

Внутренний телефон

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

HTTP-статус: 400

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

Название
тип

Описание

error
string

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

error_description
string

Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки

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

Код

Описание

Значение

FIND_SHORT

Too short a search phrase

Не передан параметр FIND

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

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

Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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