Для AI-агентов: markdown этой страницы — /docs-content/humanresources/nodes/list.md индекс документации — /llms.txt
Список узлов
GET /v1/humanresources/nodes
Возвращает список узлов организационной структуры портала одного типа — отделов или команд — с постраничной выдачей.
Параметры
| Параметр | Тип | Обяз. | Описание |
|---|---|---|---|
Параметрtype (query) |
Типstring | Обяз.да | ОписаниеТип узлов в выдаче: DEPARTMENT (отдел) или TEAM (команда). Без параметра возвращается 400 MISSING_REQUIRED_PARAMS |
Параметрlimit (query) |
Типnumber | Обяз.нет | ОписаниеКоличество записей на странице |
Параметрoffset (query) |
Типnumber | Обяз.нет | ОписаниеСмещение от начала выборки для постраничной выдачи |
Если под выбранный тип попадает больше записей, чем limit, в meta.hasMore приходит true. Чтобы получить следующую страницу, повторите запрос с увеличенным offset (offset = offset + limit), пока hasMore не станет false. Общее количество узлов в ответе не приходит, поля meta.total у этого списка нет — ориентируйтесь на meta.hasMore.
Примеры
curl — личный ключ
curl "https://vibecode.bitrix24.tech/v1/humanresources/nodes?type=DEPARTMENT" \
-H "X-Api-Key: YOUR_API_KEY"
curl — OAuth-приложение
curl "https://vibecode.bitrix24.tech/v1/humanresources/nodes?type=DEPARTMENT" \
-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?type=DEPARTMENT', {
headers: {
'X-Api-Key': 'YOUR_API_KEY',
},
})
const { success, data, meta } = await res.json()
console.log(`Отделов на странице: ${data.length}, есть ещё: ${meta.hasMore}`)
JavaScript — OAuth-приложение
const res = await fetch('https://vibecode.bitrix24.tech/v1/humanresources/nodes?type=DEPARTMENT', {
headers: {
'X-Api-Key': 'YOUR_APP_KEY',
'Authorization': 'Bearer USER_SESSION_TOKEN',
},
})
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 | ОписаниеИдентификатор родительского узла. У корневого узла равен 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, если изменений не было |
Полеmeta.hasMore |
Типboolean | ОписаниеЕсть ли ещё записи за пределами limit |
Пример ответа
{
"success": true,
"data": [
{
"id": 17,
"name": "Головной офис",
"type": "DEPARTMENT",
"structureId": 1,
"parentId": 0,
"description": null,
"accessCode": "D185",
"userCount": 0,
"colorName": null,
"xmlId": null,
"createdAt": null,
"updatedAt": null
},
{
"id": 23,
"name": "Отдел продаж",
"type": "DEPARTMENT",
"structureId": 1,
"parentId": 17,
"description": "Прямые продажи",
"accessCode": "SN23",
"userCount": 2,
"colorName": null,
"xmlId": null,
"createdAt": null,
"updatedAt": null
}
],
"meta": {
"hasMore": false
}
}
Пример ответа при ошибке
400 — не передан обязательный параметр type:
{
"success": false,
"error": {
"code": "MISSING_REQUIRED_PARAMS",
"message": "GET /v1/humanresources/nodes requires query parameters: type. Example: GET /v1/humanresources/nodes?type=..."
}
}
Ошибки
| HTTP | Код | Описание |
|---|---|---|
| HTTP400 | КодMISSING_REQUIRED_PARAMS |
ОписаниеНе передан обязательный параметр type |
| HTTP400 | КодUNSUPPORTED_FILTER |
ОписаниеПередан фильтр по полю узла, кроме type, — перечисление поддерживается только по type |
| HTTP400 | КодINVALID_SORT_FIELD |
ОписаниеПередан sort или order — узлы приходят в фиксированном порядке, сортировка не поддерживается |
| HTTP403 | КодSCOPE_DENIED |
ОписаниеКлючу не хватает скоупа humanresources |
| HTTP401 | КодTOKEN_MISSING |
ОписаниеУ API-ключа не настроены токены Битрикс24 |
Полный список общих ошибок API — Ошибки.
Известные особенности
Перечисление только по типу. Выборку нельзя сузить по произвольному полю узла. Запрос с filter[name] или filter[parentId] возвращает 400 UNSUPPORTED_FILTER до обращения к Битрикс24, а сообщение называет единственный принимаемый ключ type. Единственный способ ограничить выдачу — указать type и листать страницы через limit и offset. Чтобы найти узлы по подстроке названия и при необходимости ограничить поиск поддеревом через parentId, используйте поиск узлов.