#Агрегация сотрудников

POST /v1/users/aggregate

Подсчёт количества сотрудников с фильтрацией:

  • count — работает на любом запросе (с фильтром или без).
  • groupBy — только по пользовательским (UF) полям любого типа. Стандартные поля сущности (active, departmentId, workPosition и др.) в группировке не работают.
  • sum / avg / min / max — только по UF-полям числовых типов: integer, double, money.

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

Параметр Тип Обяз. Описание
aggregate array нет Массив агрегаций. Каждый элемент: { "field": "UF_*", "function": "sum" }. Без параметра — только count
filter object нет Фильтрация по полям GET /v1/users/fields.
Синтаксис фильтрации. Принимает camelCase и UPPER_SNAKE_CASE
groupBy string | string[] нет Имя UF-поля или массив (до 5). Стандартные поля сущности не поддерживаются — вернётся INVALID_PARAMS

#Примеры

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/users/aggregate" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "active": true }
  }'

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/users/aggregate" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "active": true }
  }'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/users/aggregate', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filter: { active: true },
  }),
})

const { success, data } = await res.json()
console.log('Активных сотрудников:', data.count)

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/users/aggregate', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filter: { active: true },
  }),
})

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

Для группировки по нескольким UF-полям передайте массив: "groupBy": ["UF_DEPARTMENT", "UF_EMPLOYMENT_DATE"] (максимум 5).

#Другие сценарии

Общее количество сотрудников портала — самый быстрый запрос, без выгрузки записей:

JSON 
{}

Группировка по UF-полю «Внутренний номер» (любой тип UF — допустим в groupBy):

JSON 
{ "groupBy": "UF_PHONE_INNER" }

Сумма по числовому UF-полю с группировкой:

JSON 
{
  "aggregate": [{ "field": "UF_SALARY", "function": "sum" }],
  "groupBy": "UF_DEPARTMENT"
}

#Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data.count number Количество записей под фильтр
data.aggregates object Результаты агрегаций (пустой объект, если в запросе не было aggregate)
data.groups array Группы (только при groupBy). Каждый элемент: значения полей группировки + count
data.meta.totalRecords number Общее количество записей под фильтр
data.meta.recordsProcessed number Количество обработанных записей
data.meta.truncated boolean true, если попало больше 5000 записей и часть не вошла в выборку

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

Ответ на запрос count без groupBy:

JSON 
{
  "success": true,
  "data": {
    "count": 57,
    "aggregates": {},
    "meta": {
      "totalRecords": 57,
      "recordsProcessed": 0,
      "truncated": false
    }
  }
}

Без groupBy поле data.groups в ответе отсутствует.

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

400 — groupBy по несуществующему UF-полю (сообщение содержит список доступных):

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "groupBy field 'nonexistent' is not aggregatable on this entity. Available: . User-defined: UF_DEPARTMENT (string), UF_PHONE_INNER (string), UF_EMPLOYMENT_DATE (string), UF_SKILLS (string), UF_INTERESTS (string), UF_LINKEDIN (string), UF_FACEBOOK (string)."
  }
}

#Ошибки

HTTP Код Описание
400 INVALID_PARAMS Несуществующее поле в groupBy или aggregate.field — сообщение содержит список доступных UF-полей
400 INVALID_PARAMS UF-поле нечислового типа (string, enumeration, date) в sum/avg/min/max — сообщение называет тип
400 INVALID_PARAMS groupBy по стандартному полю сущности — у сотрудников нет полей в aggregatable
400 INVALID_PARAMS Больше 5 полей в groupBy
401 TOKEN_MISSING API-ключ не имеет настроенных токенов
403 SCOPE_DENIED API-ключ не имеет скоупа user

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

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

count vs числовые функции. count считается одним вызовом Битрикс24 на любом объёме. sum/avg/min/max подгружают записи постранично (максимум 5000), считают на стороне Вайбкод. При более 5000 записей под фильтр — meta.truncated: true, агрегация по первым 5000. Для точного подсчёта на больших выборках — count или сужение фильтра.

Money-поля. UF-поля типа money хранятся в формате "сумма|валюта" ("50000|RUB") — агрегат извлекает числовую часть автоматически, складывать можно без парсинга.

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