Для AI-агентов: markdown этой страницы — /docs-content/entities/workgroups/fields.md индекс документации — /llms.txt
Поля рабочей группы
GET /v1/workgroups/fields
Возвращает схему полей рабочей группы и список операций, доступных в пакетных запросах.
Примеры
curl — личный ключ
curl "https://vibecode.bitrix24.tech/v1/workgroups/fields" \
-H "X-Api-Key: YOUR_API_KEY"
curl — OAuth-приложение
curl "https://vibecode.bitrix24.tech/v1/workgroups/fields" \
-H "X-Api-Key: YOUR_APP_KEY" \
-H "Authorization: Bearer USER_SESSION_TOKEN"
JavaScript — личный ключ
const res = await fetch('https://vibecode.bitrix24.tech/v1/workgroups/fields', {
headers: {
'X-Api-Key': 'YOUR_API_KEY',
},
})
const { success, data } = await res.json()
console.log('Полей:', Object.keys(data.fields).length)
console.log('Доступные batch-операции:', data.batch)
JavaScript — OAuth-приложение
const res = await fetch('https://vibecode.bitrix24.tech/v1/workgroups/fields', {
headers: {
'X-Api-Key': 'YOUR_APP_KEY',
'Authorization': 'Bearer USER_SESSION_TOKEN',
},
})
const { success, data } = await res.json()
Поля ответа
Подписи полей label и description приходят на русском языке. Заголовками запроса язык не переключается.
| Поле | Тип | Описание |
|---|---|---|
Полеsuccess |
Типboolean | ОписаниеВсегда true при успехе |
Полеdata.fields |
Типobject | ОписаниеОбъект схемы полей рабочей группы |
Полеdata.fields.<имя> |
Типobject | ОписаниеОписание одного поля |
Полеdata.fields.<имя>.type |
Типstring | ОписаниеТип значения: number, string, boolean или datetime |
Полеdata.fields.<имя>.readonly |
Типboolean | Описаниеtrue — поле заполняется системой и в запросах на запись не передаётся |
Полеdata.fields.<имя>.nullable |
Типboolean | Описаниеtrue — поле может прийти со значением null. Ключ присутствует только у таких полей |
Полеdata.batch |
Типarray | ОписаниеСписок операций сущности, доступных в POST /v1/batch: create, update, delete |
Поля рабочей группы
| Поле | Тип | Только чтение | Описание |
|---|---|---|---|
Полеid |
Типnumber | Только чтениеда | ОписаниеИдентификатор рабочей группы |
Полеname |
Типstring | Только чтение | ОписаниеНазвание |
Полеdescription |
Типstring | Только чтение | ОписаниеОписание |
Полеactive |
Типboolean | Только чтение | ОписаниеАктивна ли группа |
Полеvisible |
Типboolean | Только чтение | ОписаниеВидна ли в общих списках |
Полеopened |
Типboolean | Только чтение | ОписаниеОткрыта ли для вступления без приглашения |
ПолеownerId |
Типnumber | Только чтение | ОписаниеВладелец (ответственный). Список: GET /v1/users |
ПолеsubjectId |
Типnumber | Только чтение | ОписаниеИдентификатор темы |
ПолеsubjectName |
Типstring | Только чтениеда | ОписаниеНазвание темы |
ПолеmembersCount |
Типnumber | Только чтениеда | ОписаниеКоличество участников |
ПолеdateCreate |
Типdatetime | Только чтениеда | ОписаниеДата создания |
ПолеdateUpdate |
Типdatetime | Только чтениеда | ОписаниеДата последнего обновления |
ПолеdateActivity |
Типdatetime | Только чтениеда | ОписаниеДата последней активности |
Полеarchived |
Типboolean | Только чтение | ОписаниеПомещена ли в архив |
ПолеisProject |
Типboolean | Только чтение | ОписаниеЯвляется ли проектом с задачами и сроками |
ПолеisExtranet |
Типboolean | Только чтениеда | ОписаниеЭкстранет-группа |
Полеkeywords |
Типstring | Только чтение | ОписаниеКлючевые слова. При создании не сохраняется — задайте через PATCH |
ПолеsiteId |
Типstring | Только чтениеда | ОписаниеИдентификатор сайта портала |
ПолеimageUrl |
Типstring | Только чтениеда | ОписаниеURL аватара группы |
Доступные include
Эндпоинт GET /v1/workgroups/fields возвращает список доступных include: owner.
Пример использования: Получить рабочую группу.
Подробнее об include: Связанные данные.
Пример ответа
{
"success": true,
"data": {
"fields": {
"id": { "type": "number", "readonly": true, "label": "ID", "description": "Идентификатор рабочей группы." },
"name": { "type": "string", "readonly": false, "label": "Название", "description": "Название рабочей группы." },
"description": { "type": "string", "readonly": false, "label": "Описание", "description": "Текстовое описание рабочей группы." },
"active": { "type": "boolean", "readonly": false, "label": "Активна", "description": "Признак того, что группа активна." },
"visible": { "type": "boolean", "readonly": false, "label": "Видна в списках", "description": "Признак того, что группа отображается в общих списках." },
"opened": { "type": "boolean", "readonly": false, "label": "Открытая группа", "description": "Признак того, что вступление в группу возможно без приглашения." },
"ownerId": { "type": "number", "readonly": false, "label": "Владелец", "description": "Идентификатор пользователя, ответственного за группу." },
"subjectId": { "type": "number", "readonly": false, "label": "ID темы", "description": "Идентификатор темы (направления деятельности) рабочей группы." },
"subjectName": { "type": "string", "readonly": true, "label": "Название темы", "description": "Название темы, к которой относится рабочая группа." },
"membersCount": { "type": "number", "readonly": true, "label": "Число участников", "description": "Число участников рабочей группы." },
"dateCreate": { "type": "datetime", "readonly": true, "label": "Дата создания", "description": "Дата и время создания рабочей группы." },
"dateUpdate": { "type": "datetime", "readonly": true, "label": "Дата обновления", "description": "Дата и время последнего обновления рабочей группы." },
"dateActivity": { "type": "datetime", "readonly": true, "label": "Дата активности", "description": "Дата и время последней активности в рабочей группе." },
"archived": { "type": "boolean", "readonly": false, "label": "В архиве", "description": "Признак того, что группа помещена в архив." },
"isProject": { "type": "boolean", "readonly": false, "label": "Проект", "description": "Признак того, что группа является проектом с задачами и сроками." },
"isExtranet": { "type": "boolean", "readonly": true, "label": "Экстранет-группа", "description": "Признак только для чтения, определяемый привязкой группы к сайтам в Битрикс24. Напрямую не задаётся." },
"keywords": { "type": "string", "readonly": false, "nullable": true, "label": "Ключевые слова", "description": "Ключевые слова, связанные с рабочей группой. Значение, переданное при создании, Битрикс24 не сохраняет — группа создаётся с keywords: null. Задайте ключевые слова запросом PATCH /v1/workgroups/:id после создания группы." },
"siteId": { "type": "string", "readonly": true, "label": "ID сайта", "description": "Идентификатор сайта портала, к которому относится группа." },
"imageUrl": { "type": "string", "readonly": true, "label": "URL аватара", "description": "Ссылка на изображение аватара рабочей группы." }
},
"batch": ["create", "update", "delete"]
}
}
Пример ответа при ошибке
401 — нет ключа авторизации:
{
"success": false,
"error": {
"code": "MISSING_API_KEY",
"message": "API key is required"
}
}
Ошибки
| HTTP | Код | Описание |
|---|---|---|
| HTTP401 | КодMISSING_API_KEY |
ОписаниеНе передан заголовок X-Api-Key |
| HTTP401 | КодINVALID_API_KEY |
ОписаниеКлюч не опознан: такой строки на платформе нет |
| HTTP403 | КодSCOPE_DENIED |
ОписаниеAPI-ключ не имеет скоупа sonet_group |
| HTTP429 | КодRATE_LIMITED |
ОписаниеПревышен лимит запросов: 300 в минуту на портал, все API-ключи портала делят один лимит. Действующее значение — в заголовке x-ratelimit-limit. Повторите после срока из заголовка Retry-After |
Полный список общих ошибок API — Ошибки.
Известные особенности
- Список полей не зависит от прав пользователя ключа — возвращается полная схема сущности.
- Кроме операций, перечисленных в
data.batch, вPOST /v1/batchдля рабочих групп можно вызыватьget,listиfields.