im.department.colleagues.list
Получить список коллег текущего пользователя
Описание
Метод im.department.colleagues.list получает список коллег текущего пользователя. Для руководителя метод вернет список подчиненных и всех руководителей.
Параметры
USER_DATA
string
необязательный
Возвращать подробные данные пользователей.
Возможные значения:
- Y — да
- N — нет
По умолчанию: N
OFFSET
integer
необязательный
Смещение выборки пользователей. По умолчанию 0
LIMIT
integer
необязательный
Количество элементов в выборке. По умолчанию 10. Максимальное значение 50
Примеры запроса
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).
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).
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>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.im.department.colleagues.list(
user_data=True,
offset=0,
limit=5,
).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.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>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "im.department.colleagues.list", b24.Params{
"USER_DATA": "Y",
"OFFSET": 0,
"LIMIT": 5,
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("im.department.colleagues.list: %w", err)
}
var items []b24.ID
if err := json.Unmarshal(res.Result, &items); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println("получено:", len(items))
Ответ
HTTP-статус: 200
{
"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
}
}
Возвращаемые данные
result
array
Список пользователей.
- При USER_DATA = 'N' содержит идентификаторы пользователей
- При USER_DATA = 'Y' содержит объекты пользователей (подробное описание)
total
integer
Общее количество пользователей в выборке
next
integer
Смещение для получения следующей страницы. Поле возвращается, если есть следующая страница
time
time
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 403
{
"error": "ACCESS_ERROR",
"error_description": "Only intranet users have access to this method."
}
| Код | Описание | Значение |
|---|---|---|
403 |
ACCESS_ERROR |
Only intranet users have access to this method |

