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

Получить рабочую группу

GET /v1/workgroups/:id

Возвращает рабочую группу по идентификатору со всеми её полями.

Параметры

Параметр Тип Обяз. По умолч. Описание
id (path) number ★ да — Идентификатор рабочей группы. Список: GET /v1/workgroups
include (query) string нет — Связанные данные: owner. Подробнее — секция «Связанные данные» ниже

Примеры

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/workgroups/85" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/workgroups/85" \
  -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/85', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log('Группа:', data.name, '— участников:', data.membersCount)

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

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

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

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data.id number Идентификатор рабочей группы (только чтение)
data.name string Название
data.description string | null Описание
data.active boolean Активна ли группа
data.visible boolean Видна ли группа в общих списках
data.opened boolean Открыта ли для вступления без приглашения
data.ownerId number Идентификатор владельца (ответственного). Список: GET /v1/users
data.subjectId number Идентификатор темы
data.subjectName string Название темы (только чтение)
data.membersCount number Количество участников (только чтение)
data.dateCreate string Дата создания, ISO 8601 (только чтение)
data.dateUpdate string Дата последнего обновления, ISO 8601 (только чтение)
data.dateActivity string Дата последней активности, ISO 8601 (только чтение)
data.archived boolean Помещена ли в архив
data.isProject boolean Является ли проектом с задачами и сроками
data.isExtranet boolean Группа экстранета — с доступом для внешних пользователей
data.keywords string | null Ключевые слова
data.siteId string Идентификатор сайта портала, для основного сайта — s1 (только чтение)
data.imageUrl string | null URL аватара группы (только чтение)

Связанные данные

Получить связанную запись вместе с рабочей группой — параметр include в GET-запросе:

GET /v1/workgroups/79?include=owner

Доступный include: owner — карточка сотрудника-владельца группы. Связь читает сотрудников, поэтому ключу нужен ещё и скоуп user. Результат в поле _included:

JSON 
{
  "success": true,
  "data": {
    "id": 79,
    "name": "Меняю владельца проекта сотрудника",
    "ownerId": 1269,
    "_included": {
      "owner": {
        "id": 1269,
        "name": "Гузель",
        "lastName": "Тагирова",
        "active": true,
        "timeZone": "Europe/Moscow"
      }
    }
  }
}

Подробнее об include: Связанные данные.

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

JSON 
{
  "success": true,
  "data": {
    "id": 85,
    "siteId": "s1",
    "name": "Команда разработки нового продукта",
    "description": "Внутренний проект инфраструктуры",
    "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,
    "imageUrl": null
  }
}

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

404 — рабочая группа с таким id не существует:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "workgroup 999999 not found"
  }
}

Ошибки

HTTP Код Описание
404 ENTITY_NOT_FOUND Рабочая группа с указанным id не найдена
400 INVALID_INCLUDE Запрошена связь, которой у рабочей группы нет. Сообщение перечисляет доступные
401 MISSING_API_KEY Не передан X-Api-Key
401 INVALID_API_KEY Ключ не опознан: такой строки на платформе нет
403 SCOPE_DENIED Ключу не хватает скоупа sonet_group

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

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

  • Нечисловой id (например abc) возвращает 404 ENTITY_NOT_FOUND, а не 400 — учитывайте это при обработке ошибок валидации на клиенте.
  • Чтобы сменить тему рабочей группы, передавайте числовой subjectId в PATCH /v1/workgroups/:id. Поле subjectName доступно только для чтения — попытка передать его в теле PATCH вернёт 400 READONLY_FIELD.

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