Для AI-агентов: markdown этой страницы — /docs-content/humanresources/nodes/get.md индекс документации — /llms.txt
Получить узел
GET /v1/humanresources/nodes/:id
Возвращает один узел организационной структуры по идентификатору вместе с составом его участников. В ответ добавляется массив members с сотрудниками узла, их должностями и ролями.
Параметры
| Параметр | Тип | Обяз. | Описание |
|---|---|---|---|
Параметрid (path) |
Типnumber | Обяз.да | ОписаниеИдентификатор узла. Список идентификаторов: GET /v1/humanresources/nodes?type=DEPARTMENT |
Примеры
curl — личный ключ
curl "https://vibecode.bitrix24.tech/v1/humanresources/nodes/23" \
-H "X-Api-Key: YOUR_API_KEY"
curl — OAuth-приложение
curl "https://vibecode.bitrix24.tech/v1/humanresources/nodes/23" \
-H "X-Api-Key: YOUR_APP_KEY" \
-H "Authorization: Bearer USER_SESSION_TOKEN"
JavaScript — личный ключ
const res = await fetch('https://vibecode.bitrix24.tech/v1/humanresources/nodes/23', {
headers: {
'X-Api-Key': 'YOUR_API_KEY',
},
})
const { success, data } = await res.json()
console.log(data.name, '—', data.members.length, 'участников')
JavaScript — OAuth-приложение
const res = await fetch('https://vibecode.bitrix24.tech/v1/humanresources/nodes/23', {
headers: {
'X-Api-Key': 'YOUR_APP_KEY',
'Authorization': 'Bearer USER_SESSION_TOKEN',
},
})
const { success, data } = await res.json()
Поля ответа
| Поле | Тип | Описание |
|---|---|---|
Полеsuccess |
Типboolean | ОписаниеВсегда true при успехе |
Полеdata.id |
Типnumber | ОписаниеИдентификатор узла |
Полеdata.name |
Типstring | ОписаниеНазвание узла |
Полеdata.type |
Типstring | ОписаниеТип узла: DEPARTMENT или TEAM |
Полеdata.structureId |
Типnumber | ОписаниеИдентификатор структуры, к которой относится узел |
Полеdata.parentId |
Типnumber | ОписаниеИдентификатор родительского узла. У корневого узла равен 0 |
Полеdata.description |
Типstring | null | ОписаниеОписание узла. null, если описание не задано |
Полеdata.accessCode |
Типstring | ОписаниеКод доступа узла, например D185 или SN23. Префикс не определяется типом узла, а числовая часть может не совпадать с id — берите значение из ответа |
Полеdata.userCount |
Типnumber | ОписаниеЧисло сотрудников в узле |
Полеdata.colorName |
Типstring | null | ОписаниеНазвание цвета узла. null, если цвет не задан |
Полеdata.xmlId |
Типstring | null | ОписаниеВнешний идентификатор узла. null, если не задан |
Полеdata.createdAt |
Типstring | null | ОписаниеДата создания (ISO 8601). null для узлов, созданных без отметки времени |
Полеdata.updatedAt |
Типstring | null | ОписаниеДата последнего изменения (ISO 8601). null, если изменений не было |
Полеdata.members |
Типarray | ОписаниеСостав участников узла |
Полеdata.members[].userId |
Типnumber | ОписаниеИдентификатор сотрудника. Карточка: GET /v1/humanresources/employees |
Полеdata.members[].name |
Типstring | ОписаниеИмя сотрудника |
Полеdata.members[].workPosition |
Типstring | ОписаниеДолжность сотрудника. Пустая строка, если должность не указана |
Полеdata.members[].role |
Типstring | ОписаниеРоль сотрудника в узле. Для отдела: MEMBER_HEAD (руководитель), MEMBER_DEPUTY_HEAD (заместитель), MEMBER_EMPLOYEE (сотрудник). Для команды роли с префиксом MEMBER_TEAM_ |
Полеdata.members[].avatar |
Типstring | ОписаниеАдрес изображения профиля сотрудника |
Полеdata.members[].url |
Типstring | ОписаниеОтносительный путь к карточке сотрудника на портале |
Пример ответа
{
"success": true,
"data": {
"id": 23,
"name": "Отдел продаж",
"type": "DEPARTMENT",
"structureId": 1,
"parentId": 17,
"description": "Прямые продажи",
"accessCode": "SN23",
"userCount": 2,
"colorName": null,
"xmlId": null,
"createdAt": null,
"updatedAt": null,
"members": [
{
"userId": 1,
"name": "Иван Петров",
"workPosition": "",
"role": "MEMBER_HEAD",
"avatar": "https://cdn.bitrix24.ru/.../avatar.jpg",
"url": "/company/personal/user/1/"
},
{
"userId": 29,
"name": "Мария Соколова",
"workPosition": "Менеджер",
"role": "MEMBER_EMPLOYEE",
"avatar": "https://cdn.bitrix24.ru/.../avatar.jpg",
"url": "/company/personal/user/29/"
}
]
}
}
Пример ответа при ошибке
404 — узел не найден:
{
"success": false,
"error": {
"code": "ENTITY_NOT_FOUND",
"message": "Запись с ID = `0` не найдена"
}
}
Ошибки
| HTTP | Код | Описание |
|---|---|---|
| HTTP404 | КодENTITY_NOT_FOUND |
ОписаниеУзла с указанным id нет. Тот же код возвращается для нечислового id |
| HTTP403 | КодSCOPE_DENIED |
ОписаниеКлючу не хватает скоупа humanresources |
| HTTP401 | КодTOKEN_MISSING |
ОписаниеУ API-ключа не настроены токены Битрикс24 |
Полный список общих ошибок API — Ошибки.