Получить список подразделений department.get
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
departmentКто может выполнять метод: любой пользователь
Метод department.get возвращает список активных подразделений структуры компании, например все подразделения внутри одного родительского. Имена фильтров ID, NAME, SORT, PARENT и UF_HEAD пишите в верхнем регистре: фильтр в другом регистре метод игнорирует.
Метод относится к прежней версии API. Аналог в REST 3.0 — humanresources.node.list, соответствие методов — в обзоре раздела.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
sort |
Название поля, по которому нужна сортировка. Сортировка работает по полям:
|
|
order |
Направление сортировки, по умолчанию —
|
|
ID |
Фильтр по идентификатору подразделения |
|
NAME |
Фильтр по полному названию подразделения |
|
SORT |
Фильтр по полю сортировки. Метод принимает параметр, но не применяет: в ответ попадают подразделения с любым значением |
|
PARENT |
Фильтр по идентификатору родительского подразделения. Чтобы получить подразделение верхнего уровня, передайте |
|
UF_HEAD |
Фильтр по идентификатору руководителя подразделения |
|
start |
Параметр используется для управления постраничной навигацией. Размер страницы результатов всегда статичный: 50 записей. Чтобы выбрать вторую страницу результатов, необходимо передавать значение Формула расчета значения параметра
Подробности в статье Особенности списочных методов |
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"sort": "NAME",
"order": "DESC",
"PARENT": 1
}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/department.get
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"sort": "NAME",
"order": "DESC",
"PARENT": 1,
"auth": "**put_access_token_here**"
}' \
https://**put_your_bitrix24_address**/rest/department.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 } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
type Department = {
ID: string
NAME: string
SORT: number
PARENT?: string
UF_HEAD?: string
}
try {
const response = await $b24.actions.v2.call.make<Department[]>({
method: 'department.get',
params: {
sort: 'NAME',
order: 'DESC',
PARENT: 1,
},
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(result.map((department) => department.NAME))
}
} 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 getDepartments() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'department.get',
params: {
sort: 'NAME',
order: 'DESC',
PARENT: 1,
},
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(result.map((department) => department.NAME))
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getDepartments)
</script>
Пример
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.department.get(
sort="NAME",
order="DESC",
parent=1,
).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}")
Пример as_list
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.department.get(
sort="NAME",
order="DESC",
parent=1,
).as_list().response
result = bitrix_response.result
for item in result:
print(item)
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(
'department.get',
[
'sort' => 'NAME',
'order' => 'DESC',
'PARENT' => 1,
]
);
$result = $response
->getResponseData()
->getResult();
print_r($result);
} catch (Throwable $e) {
echo $e->getMessage();
}
BX24.callMethod(
'department.get',
{
sort: 'NAME',
order: 'DESC',
PARENT: 1,
},
function(result) {
if (result.error()) {
console.error(result.error());
} else {
console.info(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'department.get',
[
'sort' => 'NAME',
'order' => 'DESC',
'PARENT' => 1,
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "department.get", b24.Params{
"sort": "NAME",
"order": "DESC",
"PARENT": 1,
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("department.get: %w", err)
}
var items []struct {
ID b24.ID `json:"ID"`
Name string `json:"NAME"`
Sort int `json:"SORT"`
Parent string `json:"PARENT"`
}
if err := json.Unmarshal(res.Result, &items); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
for _, it := range items {
fmt.Println(it.ID, it.Name)
}
Обработка ответа
HTTP-статус: 200
{
"result": [
{
"ID": "17",
"NAME": "Юр. отдел",
"SORT": 500,
"PARENT": "1"
},
{
"ID": "3",
"NAME": "Отдел продаж",
"SORT": 500,
"PARENT": "1"
},
{
"ID": "4",
"NAME": "Отдел маркетинга и рекламы",
"SORT": 500,
"PARENT": "1"
},
{
"ID": "2",
"NAME": "Бухгалтерия",
"SORT": 500,
"PARENT": "1"
},
{
"ID": "15",
"NAME": "R\u0026D",
"SORT": 500,
"PARENT": "1"
}
],
"total": 5,
"time": {
"start": 1736924749.531017,
"finish": 1736924749.719845,
"duration": 0.1888279914855957,
"processing": 0.00179290771484375,
"date_start": "2025-01-15T07:05:49+00:00",
"date_finish": "2025-01-15T07:05:49+00:00",
"operating": 0
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Список подразделений, которые подошли под фильтр |
|
next |
Значение |
|
total |
Общее количество найденных записей |
|
time |
Информация о времени выполнения запроса |
Структура department
{
"ID": "2",
"NAME": "Бухгалтерия",
"SORT": 500,
"PARENT": "1",
"UF_HEAD": "1"
}
|
Название |
Описание |
|
ID |
Идентификатор подразделения. Число приходит строкой |
|
NAME |
Название подразделения |
|
SORT |
Поле сортировки подразделения |
|
PARENT |
Идентификатор родительского подразделения. Число приходит строкой. У подразделения верхнего уровня поля нет |
|
UF_HEAD |
Идентификатор пользователя-руководителя подразделения. Число приходит строкой. Если руководитель не назначен, поля нет или оно равно |
Обработка ошибок
У метода нет собственных ошибок. Неизвестное поле в sort метод игнорирует. Если подразделений по фильтру нет, result — пустой массив.
|
Название |
Описание |
|
error |
Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только |
|
error_description |
Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки |
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |