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

Поиск узлов

POST /v1/humanresources/nodes/search

Ищет узлы организационной структуры — отделы или команды — по подстроке названия. Обязательны два поля тела запроса: type (тип искомых узлов) и name (строка поиска по части названия).

В отличие от списка узлов, который перечисляет все узлы выбранного типа, поиск возвращает только узлы, чьё название содержит подстроку name. Дополнительно поиск можно ограничить поддеревом через parentId и числом записей через pagination.limit.

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

Поле Тип Обяз. Описание
type string да Тип искомых узлов: DEPARTMENT (отдел) или TEAM (команда)
name string да Строка поиска по части названия узла
parentId number нет Идентификатор родительского узла — ограничивает поиск его поддеревом. Положительное целое
pagination object нет Постраничная навигация. Используется только pagination.limit
pagination.limit number нет Максимальное число узлов в ответе. По умолчанию 50, максимум 200
limit number нет Псевдоним для pagination.limit на верхнем уровне тела запроса

Поля type и name передаются на верхнем уровне тела запроса, а не внутри filter. Объекты filter, order и select метод не поддерживает.

Примеры

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/humanresources/nodes/search" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "DEPARTMENT",
    "name": "Прод",
    "pagination": { "limit": 20 }
  }'

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/humanresources/nodes/search" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "DEPARTMENT",
    "name": "Прод",
    "pagination": { "limit": 20 }
  }'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/humanresources/nodes/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    type: 'DEPARTMENT',
    name: 'Прод',
    pagination: { limit: 20 },
  }),
})

const { success, data, meta } = await res.json()
console.log(`Найдено ${meta.total} отделов`)

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/humanresources/nodes/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    type: 'DEPARTMENT',
    name: 'Прод',
    pagination: { limit: 20 },
  }),
})

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

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data array Массив найденных узлов
data[].id number Идентификатор узла
data[].name string Название узла
data[].type string Тип узла: DEPARTMENT или TEAM
data[].structureId number Идентификатор структуры, к которой относится узел
data[].parentId number | null Идентификатор родительского узла. null у корневого узла
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, если изменений не было
meta.total number Число узлов в ответе
meta.hasMore boolean Есть ли ещё записи за пределами выдачи

Состав участников узла поиск не возвращает — он приходит только в ответе получения узла.

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

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
    }
  ],
  "meta": {
    "total": 1,
    "hasMore": false
  }
}

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

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

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "name is required — substring to search node names by"
  }
}

Ошибки

HTTP Код Описание
400 INVALID_PARAMS Не передан type (или он не DEPARTMENT/TEAM), не передан name, либо parentId не положительное целое
403 SCOPE_DENIED Ключу не хватает скоупа humanresources
401 TOKEN_MISSING У API-ключа не настроены токены Битрикс24

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

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

type и name обязательны и передаются на верхнем уровне. Оба поля идут прямо в теле запроса, без обёртки filter. Если опустить любое из них, ответ — 400 INVALID_PARAMS с понятным сообщением. Это отличается от списка узлов, где type передаётся параметром строки запроса, а отбора по названию нет вовсе.

Сортировка и проекция полей не поддерживаются. Метод не принимает order и select — узлы возвращаются в порядке, который отдаёт Битрикс24, со всеми полями. Для перечисления всех узлов типа используйте список узлов.

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