Получить список сотрудников подразделений im.department.employees.get

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

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

Scope: im

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

Метод im.department.employees.get получает список сотрудников указанных подразделений.

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

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

Название
тип

Описание

ID*
array

Массив идентификаторов подразделений. Можно передать строку с JSON-массивом идентификаторов.

Получить идентификатор департамента можно методом получения списка подразделений или методом поиска подразделений по названию

USER_DATA
string

Возвращать подробные данные пользователей.

Возможные значения:

  • Y — да,
  • N — нет

Примеры кода

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

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"ID":[3,7],"USER_DATA":"Y"}' \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/im.department.employees.get
        
curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"ID":[3,7],"USER_DATA":"Y","auth":"**put_access_token_here**"}' \
          https://**put_your_bitrix24_address**/rest/im.department.employees.get
        
// 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: 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: { inner_phone?: string; personal_mobile?: string } | false
          bot_data: object | null
          type: string
          website: string
          email: string
        }
        
        // Shape of the payload returned in result (match the "response handling" section of the page)
        type DepartmentEmployeesResult = Record<string, UserData[]>
        
        try {
          const response = await $b24.actions.v2.call.make<DepartmentEmployeesResult>({
            method: 'im.department.employees.get',
            params: {
              ID: [3, 7],
              USER_DATA: 'Y',
            },
            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('Departments with employees:', Object.keys(result))
            console.info('First department employees:', result[Object.keys(result)[0]])
          }
        } 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 getDepartmentEmployees() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'im.department.employees.get',
                params: {
                  ID: [3, 7],
                  USER_DATA: 'Y',
                },
                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('Departments with employees:', Object.keys(result))
              console.info('First department employees:', result[Object.keys(result)[0]])
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', getDepartmentEmployees)
        </script>
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'im.department.employees.get',
                    [
                        'ID' => [3, 7],
                        'USER_DATA' => 'Y',
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'im.department.employees.get',
            {
                ID: [3, 7],
                USER_DATA: 'Y'
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.log(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'im.department.employees.get',
            [
                'ID' => [3, 7],
                'USER_DATA' => 'Y',
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        
// client и ctx уже созданы — см. раздел «SDK для Go»
        res, err := client.Core().Call(ctx, "im.department.employees.get", b24.Params{
        	"ID":        []int{3, 7},
        	"USER_DATA": "Y",
        }, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("im.department.employees.get: %w", err)
        }
        
        // Форма ответа показана ниже на этой странице.
        fmt.Printf("%s\n", res.Result)
        

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

HTTP-статус: 200

  • При USER_DATA = 'N':

    {
                "result": {
                    "7": [3,67,61,103],
                    "3": [278,517,13]
                },
                "time": {
                    "start": 1772519829,
                    "finish": 1772519829.456118,
                    "duration": 0.456118106842041,
                    "processing": 0,
                    "date_start": "2026-03-03T09:37:09+03:00",
                    "date_finish": "2026-03-03T09:37:09+03:00",
                    "operating_reset_at": 1772520429,
                    "operating": 0.18364310264587402
                }
            }
            
  • При USER_DATA = 'Y':

    {
                "result": {
                    "7": [
                        {
                            "id": 3,
                            "active": true,
                            "name": "Иван Иванов",
                            "first_name": "Иван",
                            "last_name": "Иванов",
                            "work_position": "Системный администратор",
                            "color": "#4ba984",
                            "avatar": "https://mysite.ru/upload/avatars/ivan-ivanov.jpg",
                            "avatar_hr": "https://mysite.ru/upload/avatars/ivan-ivanov.jpg",
                            "gender": "M",
                            "birthday": "",
                            "extranet": false,
                            "network": false,
                            "bot": false,
                            "connector": false,
                            "external_auth_id": "socservices",
                            "status": "online",
                            "idle": false,
                            "last_activity_date": "2015-02-16T19:41:09+03:00",
                            "mobile_last_date": false,
                            "desktop_last_date": false,
                            "absent": false,
                            "departments": [
                                7
                            ],
                            "phones": {
                                "inner_phone": "42"
                            },
                            "bot_data": null,
                            "type": "user",
                            "website": "",
                            "email": "ivan.ivanov@mysite.ru"
                        },
                        {
                            "id": 67,
                            "active": true,
                            "name": "Анна Петрова",
                            "first_name": "Анна",
                            ...
                        },
            
                    ],
                    "3": [
                        {
                            "id": 278,
                            "active": true,
                            "name": "Мария Сидорова",
                            "first_name": "Мария",
                            "last_name": "Сидорова",
                            ...
                        },
                    ...
                    ]
                },
                "time": {
                    "start": 1772519820,
                    "finish": 1772519820.48721,
                    "duration": 0.4872100353240967,
                    "processing": 0,
                    "date_start": "2026-03-03T09:37:00+03:00",
                    "date_finish": "2026-03-03T09:37:00+03:00",
                    "operating_reset_at": 1772520420,
                    "operating": 0.18364310264587402
                }
            }
            

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

Название
тип

Описание

result
object

Корневой объект, где ключ — идентификатор подразделения, значение:

  • при USER_DATA = 'N' содержит массив идентификаторов сотрудников,
  • при USER_DATA = 'Y' содержит массив объектов с описанием пользователей (подробное описание)

time
time

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

Объект пользователя

Название
тип

Описание

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

Название
тип

Описание

personal_mobile
string

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

inner_phone
string

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

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

HTTP-статус: 400

{
            "error": "ID_EMPTY",
            "error_description": "Department ID can't be empty"
        }
        

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Статус

Код

Описание

Значение

400

ID_EMPTY

Department ID can't be empty

Не передан, передан неверно или пустым обязательный параметр ID

403

ACCESS_ERROR

Only intranet users have access to this method

Метод недоступен для экстранет-пользователей и ботов

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

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

Превышен лимит на интенсивность запросов

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут

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

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

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