#Поля рабочей группы

GET /v1/workgroups/fields

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

#Примеры

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

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

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/workgroups/fields" \
  -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/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-приложение

javascript 
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()

#Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data.fields object Объект схемы полей рабочей группы
data.fields.<имя> object Описание одного поля
data.fields.<имя>.type string Тип значения: number, string, boolean или datetime
data.fields.<имя>.readonly boolean Доступно ли поле для записи через POST / PATCH
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 Ключевые слова
siteId string да Идентификатор сайта портала
imageUrl string да URL аватара группы

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

JSON 
{
  "success": true,
  "data": {
    "fields": {
      "id": { "type": "number", "readonly": true },
      "name": { "type": "string", "readonly": false },
      "description": { "type": "string", "readonly": false },
      "active": { "type": "boolean", "readonly": false },
      "visible": { "type": "boolean", "readonly": false },
      "opened": { "type": "boolean", "readonly": false },
      "ownerId": { "type": "number", "readonly": false },
      "subjectId": { "type": "number", "readonly": false },
      "subjectName": { "type": "string", "readonly": true },
      "membersCount": { "type": "number", "readonly": true },
      "dateCreate": { "type": "datetime", "readonly": true },
      "dateUpdate": { "type": "datetime", "readonly": true },
      "dateActivity": { "type": "datetime", "readonly": true },
      "archived": { "type": "boolean", "readonly": false },
      "isProject": { "type": "boolean", "readonly": false },
      "isExtranet": { "type": "boolean", "readonly": false },
      "keywords": { "type": "string", "readonly": false },
      "siteId": { "type": "string", "readonly": true },
      "imageUrl": { "type": "string", "readonly": true }
    },
    "batch": ["create", "update", "delete"]
  }
}

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

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

JSON 
{
  "success": false,
  "error": {
    "code": "MISSING_API_KEY",
    "message": "API key is required"
  }
}

#Ошибки

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

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

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

  • Список полей не зависит от прав пользователя ключа — возвращается полная схема сущности.
  • Кроме операций, перечисленных в data.batch, в `POST /v1/batch` для рабочих групп можно вызывать get, list и fields.

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