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

GET /v1/workgroups

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

#Параметры

Параметр Тип Обяз. По умолч. Описание
filter (query) object нет — Фильтрация по полям GET /v1/workgroups/fields.
Синтаксис фильтрации. Пример: ?filter[archived]=N
select (query) array нет — Список полей в ответе. Имена — из GET /v1/workgroups/fields.
sort (query) object нет — Сортировка: sort[<поле>]=ASC|DESC. Пример: ?sort[dateCreate]=DESC.
limit (query) number нет 50 Максимум записей в ответе. Допустимо до 5000.
offset (query) number нет 0 Смещение от начала выборки.

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

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

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

#Примеры

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/workgroups?limit=3" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/workgroups?limit=3" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/workgroups?limit=3', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

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

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/workgroups?limit=3', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

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,
      "siteId": "s1",
      "name": "Маркетинг 2026",
      "description": null,
      "dateCreate": "2026-03-20T06:45:10.000Z",
      "dateUpdate": "2026-03-20T06:45:10.000Z",
      "active": true,
      "visible": true,
      "opened": false,
      "archived": false,
      "subjectId": 1,
      "ownerId": 1271,
      "keywords": null,
      "membersCount": 2,
      "dateActivity": "2026-03-20T06:45:10.000Z",
      "subjectName": "Рабочие группы",
      "isProject": true,
      "isExtranet": false
    },
    {
      "id": 83,
      "siteId": "s1",
      "name": "Команда разработки нового продукта",
      "description": null,
      "dateCreate": "2026-03-20T06:41:07.000Z",
      "dateUpdate": "2026-03-20T06:41:07.000Z",
      "active": true,
      "visible": true,
      "opened": false,
      "archived": false,
      "subjectId": 1,
      "ownerId": 1269,
      "keywords": null,
      "membersCount": 1,
      "dateActivity": "2026-03-20T06:41:07.000Z",
      "subjectName": "Рабочие группы",
      "isProject": true,
      "imageUrl": "https://cdn-ru.bitrix24.ru/example/disk/avatar.jpg",
      "isExtranet": false
    },
    {
      "id": 81,
      "siteId": "s1",
      "name": "Запуск регионального офиса",
      "description": null,
      "dateCreate": "2026-03-20T06:29:07.000Z",
      "dateUpdate": "2026-03-20T06:29:07.000Z",
      "active": true,
      "visible": true,
      "opened": false,
      "archived": false,
      "subjectId": 1,
      "ownerId": 1271,
      "keywords": null,
      "membersCount": 1,
      "dateActivity": "2026-03-20T06:29:07.000Z",
      "subjectName": "Рабочие группы",
      "isProject": true,
      "isExtranet": false
    }
  ],
  "meta": {
    "total": 33,
    "hasMore": true
  }
}

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

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

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

#Ошибки

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

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

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

Логические поля в фильтре принимают Y / N. В ответе те же поля приходят как true / false, но при фильтрации используйте filter[active]=Y / filter[archived]=N. Значения true / false в фильтре не дадут совпадений и не вызовут ошибку.

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

limit = 0 возвращает все записи, а не пустой массив. Для пустой выборки используйте фильтр, который заведомо ничего не находит.

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