Получить список коллег текущего пользователя im.department.colleagues.list

Scope: im

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

Метод im.department.colleagues.list получает список коллег текущего пользователя. Для руководителя метод вернет список подчиненных и всех руководителей.

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

Название `тип`	Описание
USER_DATA `string`	Возвращать подробные данные пользователей. Возможные значения: `Y` — да `N` — нет
OFFSET `integer`	Смещение выборки пользователей
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 '{"USER_DATA":"Y","OFFSET":0,"LIMIT":5}' \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/im.department.colleagues.list

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"USER_DATA":"Y","OFFSET":0,"LIMIT":5,"auth":"**put_access_token_here**"}' \
          https://**put_your_bitrix24_address**/rest/im.department.colleagues.list

try
        {
            const response = await $b24.callMethod(
                'im.department.colleagues.list',
                {
                    USER_DATA: 'Y',
                    OFFSET: 0,
                    LIMIT: 5,
                }
            );
        
            console.log(response.getData().result);
            console.log(response.getData().total);
            console.log(response.getData().next);
        }
        catch (error)
        {
            console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'im.department.colleagues.list',
                    [
                        'USER_DATA' => 'Y',
                        'OFFSET' => 0,
                        'LIMIT' => 5,
                    ]
                );
        
            $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.colleagues.list',
            {
                USER_DATA: 'Y',
                OFFSET: 0,
                LIMIT: 5,
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.log(result.data());
                    console.log(result.total());
                    console.log(result.answer.next);
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'im.department.colleagues.list',
            [
                'USER_DATA' => 'Y',
                'OFFSET' => 0,
                'LIMIT' => 5,
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

HTTP-статус: 200

При USER_DATA = 'N':

{
            "result": [9,547,408,103,290],
            "next": 5,
            "total": 7,
            "time": {
                "start": 1772520802,
                "finish": 1772520802.36194,
                "duration": 0.3619399070739746,
                "processing": 0,
                "date_start": "2026-03-03T09:53:22+03:00",
                "date_finish": "2026-03-03T09:53:22+03:00",
                "operating_reset_at": 1772521402,
                "operating": 0
            }
        }

При USER_DATA = 'Y':

{
            "result": [
                {
                    "id": 9,
                    "active": true,
                    "name": "Анна Петрова",
                    "first_name": "Анна",
                    "last_name": "Петрова",
                    "work_position": "Менеджер проектов",
                    "color": "#58cc47",
                    "avatar": "https://mysite.ru/upload/avatars/anna-petrova.jpg",
                    "avatar_hr": "https://mysite.ru/upload/avatars/anna-petrova.jpg",
                    "gender": "M",
                    "birthday": "",
                    "extranet": false,
                    "network": false,
                    "bot": false,
                    "connector": false,
                    "external_auth_id": "socservices",
                    "status": "online",
                    "idle": false,
                    "last_activity_date": "2023-03-10T17:16:44+03:00",
                    "mobile_last_date": false,
                    "desktop_last_date": false,
                    "absent": false,
                    "departments": [
                        1,
                        667
                    ],
                    "phones": false,
                    "bot_data": null,
                    "type": "user",
                    "website": "",
                    "email": "anna.petrova@mysite.ru"
                },
                ... // описание для каждого пользователя
            ],
            "next": 5,
            "total": 7,
            "time": {
                "start": 1772521273,
                "finish": 1772521273.83899,
                "duration": 0.8389899730682373,
                "processing": 0,
                "date_start": "2026-03-03T10:01:13+03:00",
                "date_finish": "2026-03-03T10:01:13+03:00",
                "operating_reset_at": 1772521873,
                "operating": 0
            }
        }

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

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

Объект user

Название `тип`	Описание
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-статус: 403

{
            "error": "ACCESS_ERROR",
            "error_description": "Only intranet users have access to this method."
        }

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

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

Статус	Код	Описание	Значение
`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	Превышен лимит на интенсивность запросов
`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.department.colleagues.list

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

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

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

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

Объект userОбъект user

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

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

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

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

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