#Получить узел

GET /v1/humanresources/nodes/:id

Возвращает один узел организационной структуры по идентификатору вместе с составом его участников. В ответ добавляется массив members с сотрудниками узла, их должностями и ролями.

#Параметры

Параметр Тип Обяз. Описание
id (path) number да Идентификатор узла. Список идентификаторов: GET /v1/humanresources/nodes?type=DEPARTMENT

#Примеры

#curl — личный ключ

Terminal 
curl "https://vibecode.bitrix24.tech/v1/humanresources/nodes/23" \
  -H "X-Api-Key: YOUR_API_KEY"

#curl — OAuth-приложение

Terminal 
curl "https://vibecode.bitrix24.tech/v1/humanresources/nodes/23" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

#JavaScript — личный ключ

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-приложение

javascript 
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 для команды)
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 Относительный путь к карточке сотрудника на портале

#Пример ответа

JSON 
{
  "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 — узел не найден:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Запись с ID = `0` не найдена"
  }
}

#Ошибки

HTTP Код Описание
404 ENTITY_NOT_FOUND Узла с указанным id нет. Тот же код возвращается для нечислового id
403 SCOPE_DENIED Ключу не хватает скоупа humanresources
401 TOKEN_MISSING У API-ключа не настроены токены Битрикс24

Полный список общих ошибок API — Ошибки.

#Смотрите также