Для 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 — личный ключ
curl "https://vibecode.bitrix24.tech/v1/workgroups/85" \
-H "X-Api-Key: YOUR_API_KEY"
curl — OAuth-приложение
curl "https://vibecode.bitrix24.tech/v1/workgroups/85" \
-H "X-Api-Key: YOUR_APP_KEY" \
-H "Authorization: Bearer USER_SESSION_TOKEN"
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-приложение
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:
{
"success": true,
"data": {
"id": 79,
"name": "Меняю владельца проекта сотрудника",
"ownerId": 1269,
"_included": {
"owner": {
"id": 1269,
"name": "Гузель",
"lastName": "Тагирова",
"active": true,
"timeZone": "Europe/Moscow"
}
}
}
}
Подробнее об include: Связанные данные.
Пример ответа
{
"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 не существует:
{
"success": false,
"error": {
"code": "ENTITY_NOT_FOUND",
"message": "workgroup 999999 not found"
}
}
Ошибки
| HTTP | Код | Описание |
|---|---|---|
| HTTP404 | КодENTITY_NOT_FOUND |
ОписаниеРабочая группа с указанным id не найдена |
| HTTP400 | КодINVALID_INCLUDE |
ОписаниеЗапрошена связь, которой у рабочей группы нет. Сообщение перечисляет доступные |
| HTTP401 | КодMISSING_API_KEY |
ОписаниеНе передан X-Api-Key |
| HTTP401 | КодINVALID_API_KEY |
ОписаниеКлюч не опознан: такой строки на платформе нет |
| HTTP403 | КодSCOPE_DENIED |
ОписаниеКлючу не хватает скоупа sonet_group |
Полный список общих ошибок API — Ошибки.
Известные особенности
- Нечисловой
id(напримерabc) возвращает404 ENTITY_NOT_FOUND, а не400— учитывайте это при обработке ошибок валидации на клиенте. - Чтобы сменить тему рабочей группы, передавайте числовой
subjectIdвPATCH /v1/workgroups/:id. ПолеsubjectNameдоступно только для чтения — попытка передать его в теле PATCH вернёт400 READONLY_FIELD.