Получить список коллег текущего пользователя im.department.colleagues.list
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
imКто может выполнять метод: любой интранет-пользователь, кроме ботов
Метод im.department.colleagues.list получает список коллег текущего пользователя. Для руководителя метод вернет список подчиненных и всех руководителей.
Параметры метода
|
Название |
Описание |
|
USER_DATA |
Возвращать подробные данные пользователей. Возможные значения:
|
|
OFFSET |
Смещение выборки пользователей |
|
LIMIT |
Количество элементов в выборке. По умолчанию |
Примеры кода
Как использовать примеры в документации
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
// 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 ColleagueUser returned in result[]
type ColleagueUser = {
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: { personal_mobile?: string; inner_phone?: string } | false
bot_data: object | null
type: string
website: string
email: string
}
try {
// im.department.colleagues.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<ColleagueUser[]>({
method: 'im.department.colleagues.list',
params: {
USER_DATA: 'Y',
OFFSET: 0,
LIMIT: 5,
},
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('Colleagues:', 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 fetchColleagueList() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
// im.department.colleagues.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.department.colleagues.list',
params: {
USER_DATA: 'Y',
OFFSET: 0,
LIMIT: 5,
},
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('Colleagues:', result.length, result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', fetchColleagueList)
</script>
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 |
Список пользователей.
|
|
total |
Общее количество пользователей в выборке |
|
next |
Смещение для получения следующей страницы. Поле возвращается, если есть следующая страница |
|
time |
Информация о времени выполнения запроса |
Объект user
|
Название |
Описание |
|
id |
Идентификатор пользователя |
|
active |
Признак активности пользователя |
|
name |
Имя и фамилия пользователя |
|
first_name |
Имя пользователя |
|
last_name |
Фамилия пользователя |
|
work_position |
Должность пользователя |
|
color |
Цвет пользователя в формате hex |
|
avatar |
Ссылка на аватар |
|
avatar_hr |
Ссылка на аватар высокого разрешения |
|
gender |
Пол пользователя |
|
birthday |
День рождения в формате |
|
extranet |
Признак внешнего пользователя |
|
network |
Признак пользователя Битрикс24 Network |
|
bot |
Признак бота |
|
connector |
Признак пользователя открытых линий |
|
external_auth_id |
Код внешней авторизации |
|
status |
Статус пользователя |
|
idle |
Дата бездействия пользователя или |
|
last_activity_date |
Дата последней активности пользователя |
|
mobile_last_date |
Дата последней активности в мобильном приложении или |
|
desktop_last_date |
Дата последней активности в десктопном приложении или |
|
absent |
Дата окончания отсутствия пользователя или |
|
departments |
Массив идентификаторов подразделений |
|
phones |
Телефоны пользователя или |
|
bot_data |
Данные бота или |
|
type |
Тип пользователя |
|
website |
Сайт пользователя |
|
email |
Email пользователя |
Объект phones
|
Название |
Описание |
|
personal_mobile |
Мобильный телефон |
|
inner_phone |
Внутренний телефон |
Обработка ошибок
HTTP-статус: 403
{
"error": "ACCESS_ERROR",
"error_description": "Only intranet users have access to this method."
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Статус |
Код |
Описание |
Значение |
|
|
|
Only intranet users have access to this method |
Метод недоступен для экстранет-пользователей и ботов |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |