Для AI-агентов: markdown этой страницы — /docs-content/humanresources/employees.md индекс документации — /llms.txt

Сотрудники

Поиск сотрудников по имени, получение их подчинённых, общего количества сотрудников и списка тех, кто входит в несколько подразделений одновременно.

Битрикс24 API: humanresources.employee.* Скоуп: humanresources

Поиск сотрудников

POST /v1/humanresources/employees/search

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

Поля запроса (body)

Поле Тип Обяз. Описание
Полеname Типstring Обяз.да ОписаниеСтрока для поиска по имени сотрудника
ПолеnodeId Типnumber Обяз.нет ОписаниеОграничить поиск сотрудниками одного узла. Список: GET /v1/humanresources/nodes?type=DEPARTMENT

Примеры

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

Terminal
curl -X POST "https://vibecode.bitrix24.tech/v1/humanresources/employees/search" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "name": "Иван" }'

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

Terminal
curl -X POST "https://vibecode.bitrix24.tech/v1/humanresources/employees/search" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "name": "Иван" }'

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

javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/humanresources/employees/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ name: 'Иван' }),
})

const { success, data } = await res.json()
console.log(`Найдено ${data.items.length} сотрудников`)

JavaScript — OAuth-приложение

javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/humanresources/employees/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ name: 'Иван' }),
})

const { success, data } = await res.json()

Поля ответа

Поле Тип Описание
Полеsuccess Типboolean ОписаниеВсегда true при успехе
Полеdata.items Типarray ОписаниеМассив найденных сотрудников. Пустой, если совпадений нет
Полеdata.items[].userId Типnumber ОписаниеИдентификатор сотрудника
Полеdata.items[].name Типstring ОписаниеИмя сотрудника
Полеdata.items[].workPosition Типstring ОписаниеДолжность сотрудника. Пустая строка, если должность не указана
Полеdata.items[].avatar Типstring ОписаниеАдрес изображения профиля сотрудника
Полеdata.items[].url Типstring ОписаниеОтносительный путь к карточке сотрудника на портале
Полеdata.items[].departments Типarray ОписаниеПодразделения, в которые входит сотрудник
Полеdata.items[].departments[].id Типnumber ОписаниеИдентификатор подразделения
Полеdata.items[].departments[].name Типstring ОписаниеНазвание подразделения
Полеdata.items[].teams Типarray ОписаниеКоманды, в которые входит сотрудник. Структура элемента совпадает с departments (id, name)

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

JSON
{
  "success": true,
  "data": {
    "items": [
      {
        "userId": 1,
        "name": "Иван Петров",
        "workPosition": "",
        "avatar": "https://cdn.bitrix24.ru/.../avatar.jpg",
        "url": "/company/personal/user/1/",
        "departments": [
          { "id": 1, "name": "Компания" },
          { "id": 9, "name": "Подразделение" },
          { "id": 11, "name": "Рабочая группа" },
          { "id": 23, "name": "Отдел продаж" }
        ],
        "teams": []
      }
    ]
  }
}

Пример ответа при ошибке

400 — поле name не передано:

JSON
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "Ошибка при валидации объекта запроса",
    "validation": [
      {
        "field": "MISSING_NAME",
        "message": "Parameter \"name\" is required."
      }
    ]
  }
}

Ошибки

HTTP Код Описание
HTTP400 КодINVALID_PARAMS ОписаниеПоле name отсутствует — в error.validation приходит запись MISSING_NAME
HTTP403 КодSCOPE_DENIED ОписаниеКлючу не хватает скоупа humanresources
HTTP401 КодTOKEN_MISSING ОписаниеУ API-ключа не настроены токены Битрикс24

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

Известные особенности

Пустой результат — это успех, а не ошибка. Если по имени нет совпадений, ответ остаётся успешным (success: true), а data.items приходит пустым массивом.

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