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

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

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

Scope: im

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

Метод 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

  • При 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
string

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

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

Статус

Код

Описание

Значение

403

ACCESS_ERROR

Only intranet users have access to this method

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

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

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

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

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