#Поиск рабочих групп

POST /v1/workgroups/search

Возвращает список рабочих групп по заданным фильтрам. Тот же контракт, что GET /v1/workgroups, но условия передаются в теле запроса — подходит для длинных фильтров и нелатинских значений.

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

Поле Тип Описание
filter object Условия фильтрации. Список полей: GET /v1/workgroups/fields. Синтаксис: Фильтрация.
select array Список полей в ответе. Имена — из GET /v1/workgroups/fields.
sort object Сортировка: {"<поле>": "ASC"|"DESC"}.
limit number Максимум записей. По умолчанию 50, максимум 5000.
offset number Смещение от начала выборки. По умолчанию 0.

Для limit > 50 Вайбкод автоматически пагинирует запрос на стороне сервера. Максимум — 5000 записей за вызов. Если под фильтр попадает больше — meta.hasMore придёт true.

#Получить только проекты

В одной коллекции хранятся и рабочие группы, и проекты. Поле isProject различает их: true — проект, false — обычная рабочая группа. Для выборки проектов передавайте "filter": { "isProject": "Y" }.

#Примеры

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/workgroups/search" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "%name": "Маркетинг", "archived": "N" },
    "select": ["id", "name", "ownerId", "membersCount"],
    "sort": { "dateCreate": "DESC" },
    "limit": 5
  }'

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/workgroups/search" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "%name": "Маркетинг", "archived": "N" },
    "select": ["id", "name", "ownerId", "membersCount"],
    "sort": { "dateCreate": "DESC" },
    "limit": 5
  }'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/workgroups/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filter: { '%name': 'Маркетинг', archived: 'N' },
    select: ['id', 'name', 'ownerId', 'membersCount'],
    sort: { dateCreate: 'DESC' },
    limit: 5,
  }),
})

const { success, data, meta } = await res.json()
console.log(`Найдено ${meta.total} рабочих групп`)

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/workgroups/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filter: { '%name': 'Маркетинг', archived: 'N' },
    select: ['id', 'name', 'ownerId', 'membersCount'],
    sort: { dateCreate: 'DESC' },
    limit: 5,
  }),
})

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

#Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data array Массив рабочих групп (все поля — см. Поля рабочей группы)
meta.total number Общее количество записей по фильтру
meta.hasMore boolean Есть ли ещё записи за пределами limit

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

JSON 
{
  "success": true,
  "data": [
    {
      "id": 85,
      "name": "Маркетинг 2026",
      "ownerId": 1271,
      "membersCount": 2,
      "dateCreate": "2026-03-20T06:45:10.000Z"
    },
    {
      "id": 83,
      "name": "Команда разработки нового продукта",
      "ownerId": 1269,
      "membersCount": 1,
      "dateCreate": "2026-03-20T06:41:07.000Z"
    },
    {
      "id": 81,
      "name": "Запуск регионального офиса",
      "ownerId": 1271,
      "membersCount": 1,
      "dateCreate": "2026-03-20T06:29:07.000Z"
    }
  ],
  "meta": {
    "total": 3,
    "hasMore": false
  }
}

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

401 — не передан ключ авторизации:

JSON 
{
  "success": false,
  "error": {
    "code": "MISSING_API_KEY",
    "message": "API key required. Pass via X-Api-Key header."
  }
}

#Ошибки

HTTP Код Описание
400 INVALID_PARAMS Тело запроса не парсится или содержит недопустимые поля
401 MISSING_API_KEY Не передан заголовок X-Api-Key
401 INVALID_API_KEY Переданный ключ не распознан
403 SCOPE_DENIED Ключу не хватает скоупа sonet_group

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

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

Логические поля в фильтре можно передавать двумя способами. В теле POST допустимы и Y / N, и нативные JSON true / false: "filter": {"active": "Y"} и "filter": {"active": true} дают одинаковую выборку. В ответе те же поля всегда приходят как true / false.

Префикс % в имени поля — поиск по подстроке. "filter": {"%name": "Маркетинг"} найдёт все группы, в названии которых встречается «Маркетинг». Без префикса фильтр требует точного совпадения.

Параметр сортировки в теле — sort. Ключ order в теле игнорируется без ошибки — выборка возвращается в порядке по умолчанию. Используйте "sort": {"dateCreate": "DESC"} или строковую форму "sort": "dateCreate" (направление по умолчанию — ASC).

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