Получить данные о рабочей группе socialnetwork.api.workgroup.get

Если вы разрабатываете интеграции для Битрикс24 с помощью AI-инструментов (Codex, Claude Code, Cursor), подключите MCP-сервер, чтобы ассистент использовал официальную REST-документацию.

Scope: socialnetwork

Кто может выполнять метод: любой пользователь

Метод socialnetwork.api.workgroup.get возвращает информацию о рабочей группе, проекте, скраме или коллабе по идентификатору.

Администратор может получить информацию о любой группе на портале, даже если она секретная и он в ней не состоит.

Параметры метода

Обязательные параметры отмечены *

Название `тип`	Описание
params* `object`	Параметры запроса для получения группы. Подробнее ниже

Параметр params

Обязательные параметры отмечены *

Название `тип`	Описание
groupId* `integer`	Идентификатор группы. Значение для поля может быть получено методом sonet_group.get
select `array`	Список дополнительных полей для извлечения, возвращаемых в `result`. Подробнее ниже
mode `string`	Режим запроса. Может принимать только значение `mobile`, которое позволяет получить дополнительные данные в массиве `result[ADDITIONAL_DATA]`

Параметр select

Название `тип`	Описание
ACTIONS `string`	Доступные текущему пользователю операции над группой
AVATAR `string`	URL сжатого пользовательского аватара группы
AVATAR_DATA `string`	Информация об аватаре группы
AVATAR_TYPES `string`	Типы аватаров для групп
COUNTERS `string`	Количество непринятых запросов и приглашений на вступление в группу
DATE_CREATE `string`	Дата и время создания группы в более читаемом формате
DEPARTMENTS `string`	Отделы сотрудников, добавленные в группу
EFFICIENCY `string`	Эффективность группы
FEATURES `string`	Доступные в группе инструменты, указанные в расширенных настройках группы
GROUP_MEMBERS_LIST `string`	Список активных участников группы, приглашенных пользователей и пользователей, ожидающих подтверждения вступления в группу
LIST_OF_MEMBERS `string`	Список участников группы с информацией о них
LIST_OF_MEMBERS_AWAITING_INVITE `string`	Пользователи, ожидающие подтверждения вступления в группу
OWNER_DATA `string`	Данные о владельце группы
PIN `string`	Закреплена ли группа у текущего пользователя на странице групп и проектов. Возвращается ключом `result[IS_PIN]`
PRIVACY_TYPE `string`	Уровень приватности группы. Возвращается ключом `result[PRIVACY_CODE]`
SUBJECT_DATA `string`	Информация о тематике группы, указанной в расширенных настройках группы
TAGS `string`	Теги группы, указанные в расширенных настройках группы
USER_DATA `string`	Данные о роли текущего пользователя в группе

Примеры кода

Как использовать примеры в документации

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"params":{"groupId":622,"select":["DEPARTMENTS","TAGS"]}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/socialnetwork.api.workgroup.get

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"params":{"groupId":622,"select":["DEPARTMENTS","TAGS"]},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/socialnetwork.api.workgroup.get

try
        {
        	const response = await $b24.callMethod(
        		'socialnetwork.api.workgroup.get',
        		{
        			params: {
        				groupId: 622,
        				select: [ 'DEPARTMENTS', 'TAGS' ],
        			},
        		}
        	);
        	
        	const result = response.getData().result;
        	console.log(result);
        }
        catch( error )
        {
        	console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'socialnetwork.api.workgroup.get',
                    [
                        'params' => [
                            'groupId' => 622,
                            'select'  => [ 'DEPARTMENTS', 'TAGS' ],
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting workgroup info: ' . $e->getMessage();
        }

BX24.callMethod(
            'socialnetwork.api.workgroup.get', {
            params: {
                groupId: 622,
                select: [ 'DEPARTMENTS', 'TAGS' ],
            },
        }, result => {
            console.log(result);
        });

require_once('crest.php');
        
        $result = CRest::call(
            'socialnetwork.api.workgroup.get',
            [
                'params' => [
                    'groupId' => 622,
                    'select' => ['DEPARTMENTS', 'TAGS']
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Как использовать примеры в документации

Обработка ответа

HTTP-статус: 200

{
            "result": {
                "ID": 622,
                "ACTIVE": "Y",
                "SITE_ID": "s1",
                "SUBJECT_ID": 1,
                "NAME": "Группа для демонстрации метода",
                "DESCRIPTION": "Первая строка описания группы\r\nВторая строка описания группы",
                "KEYWORDS": "тег группы,еще один тег группы",
                "CLOSED": "N",
                "VISIBLE": "Y",
                "OPENED": "N",
                "DATE_CREATE": "17.04.2025 19:37:55",
                "DATE_UPDATE": "17.04.2025 19:40:48",
                "DATE_ACTIVITY": "17.04.2025 19:40:48",
                "IMAGE_ID": 0,
                "AVATAR_TYPE": "folder",
                "OWNER_ID": 1,
                "INITIATE_PERMS": "K",
                "NUMBER_OF_MEMBERS": 1,
                "NUMBER_OF_MODERATORS": 1,
                "PROJECT": "N",
                "PROJECT_DATE_START": null,
                "PROJECT_DATE_FINISH": null,
                "SEARCH_INDEX": "Группа для демонстрации метода Первая строка описания группы\r\nВторая строка описания группы тег группы #тег группы еще один тег группы #еще один тег группы group@example.com",
                "LANDING": "N",
                "SCRUM_OWNER_ID": 0,
                "SCRUM_SPRINT_DURATION": 0,
                "SCRUM_TASK_RESPONSIBLE": "",
                "TYPE": "group",
                "MEMBERS": [
                    1,
                    10,
                    20
                ],
                "CHAT_ID": 1034,
                "DIALOG_ID": "chat1034",
                "ORDINARY_MEMBERS": [
                    10
                ],
                "INVITED_MEMBERS": [
                    38
                ],
                "MODERATOR_MEMBERS": [
                    20
                ],
                "SITE_IDS": [
                    "s1"
                ],
                "TAGS": [
                    "еще один тег группы",
                    "тег группы"
                ],
                "DEPARTMENTS": [
                    8
                ],
                "NUMBER_OF_MEMBERS_PLURAL": 0
            },
            "time": {
                "start": 1744908074.244266,
                "finish": 1744908074.279072,
                "duration": 0.034806013107299805,
                "processing": 0.010703086853027344,
                "date_start": "2025-04-17T19:41:14+03:00",
                "date_finish": "2025-04-17T19:41:14+03:00",
                "operating_reset_at": 1744908674,
                "operating": 0
            }
        }

Возвращаемые данные

Название `тип`	Описание
result `object`	Результат выполнения запроса. Подробнее ниже
time `time`	Информация о времени выполнения запроса

Ключ result

Название `тип`	Описание
ID `integer`	Идентификатор группы
ACTIVE `boolean`	Флаг `Y`/`N` — является ли группа активной. Активировать или деактивировать группу можно с помощью метода sonet_group.update
SITE_ID `string`	Идентификатор сайта, которому принадлежит группа
SUBJECT_ID `integer`	Идентификатор тематики группы. Тематика группы указывается в расширенных настройках группы
NAME `string`	Имя группы
DESCRIPTION `text`	Описание группы
KEYWORDS `string`	Теги группы через запятую: `тег1,тег2`
CLOSED `boolean`	Флаг `Y`/`N` — является ли группа архивной
VISIBLE `boolean`	Флаг `Y`/`N` — видна ли группа в списке групп
OPENED `boolean`	Флаг `Y`/`N` — является ли группа открытой
DATE_CREATE `string`	Дата создания группы в формате `DD.MM.YYYY hh:mm:ss`. Если ключ `DATE_CREATE` запрошен в `select`, то дата возвращается в более читаемом формате, например: `сегодня, 12:16` `вчера, 14:42` `15 апреля 14:42`, если группа создана в этом году `11 июня 2024 15:08`, если группа создана не в этом году
DATE_UPDATE `string`	Дата обновления группы в формате `DD.MM.YYYY hh:mm:ss`
DATE_ACTIVITY `string`	Дата последней активности в группе в формате `DD.MM.YYYY hh:mm:ss`
IMAGE_ID `integer`	Идентификатор пользовательского аватара группы в таблице `b_file`. `0`, если используется системное изображение в качестве аватара
AVATAR_TYPE `string`	Тип последнего установленного системного аватара: `folder` — аватар в виде папки `checks` — аватар в виде чекбокса `pie` — аватар в виде графика «пирог» `bag` — аватар в виде портфеля `members` — аватар в виде силуэтов `""` — иной системный аватар
OWNER_ID `user`	Идентификатор владельца группы
INITIATE_PERMS `enum`	Кто имеет право на приглашение пользователей в группу: `A` — только владелец группы `E` — владелец группы и модераторы группы `K` — все члены группы
NUMBER_OF_MEMBERS `integer`	Количество участников группы
NUMBER_OF_MODERATORS `integer`	Количество модераторов группы
PROJECT `boolean`	Флаг `Y`/`N` — является ли группа проектом
PROJECT_DATE_START `any`	Дата начала проекта в формате `DD.MM.YYYY hh:mm:ss`. `null`, если не указана
PROJECT_DATE_FINISH `any`	Дата окончания проекта в формате `DD.MM.YYYY hh:mm:ss`. `null`, если не указана
SEARCH_INDEX `string`	Индекс, ключевые слова для поиска группы
LANDING `boolean`	Флаг `Y`/`N` — является ли группа группой для публикации
SCRUM_MASTER_ID `integer`	Идентификатор мастера скрама. `0`, если группа не является скрамом
SCRUM_SPRINT_DURATION `integer`	Длительность спринта скрама в секундах. `0`, если группа не является скрамом
SCRUM_TASK_RESPONSIBLE `string`	Исполнитель по умолчанию при постановке задач: `A` — постановщик `M` — скрам-мастер `""` — группа не является скрамом
TYPE `enum`	Тип группы: `group` — группа `project` — проект `scrum` — скрам `collab` — коллаба
MEMBERS `array`	Идентификаторы участников группы
CHAT_ID `integer`	Идентификатор чата группы
DIALOG_ID `string`	Идентификатор диалога группы
ORDINARY_MEMBERS `array`	Массив идентификаторов пользователей группы, не являющихся владельцами или модераторами
INVITED_MEMBERS `array`	Массив идентификаторов пользователей портала, которым было отправлено приглашение в группу, но они его еще не приняли
MODERATOR_MEMBERS `array`	Массив идентификаторов участников группы с ролью модератора
SITE_IDS `array`	Список идентификаторов сайтов, которым принадлежит группа
AVATAR `string`	URL сжатого пользовательского аватара группы. `""`, если пользовательский аватар не установлен
AVATAR_TYPES `object`	Объект, содержащий аватары групп (подробное описание)
AVATAR_DATA `object`	Информация об аватаре группы (подробное описание)
OWNER_DATA `object`	Информация о владельце группы (подробное описание)
SUBJECT_DATA `object`	Информация о тематике группы, указанной в расширенных настройках группы (подробное описание)
TAGS `array`	Теги группы, аналогично `KEYWORDS`, но в формате массива
ACTIONS `object`	Данные о доступных текущему пользователю операциях над группой (подробное описание)
USER_DATA `object`	Информация о текущем пользователе относительно группы (подробное описание)
DEPARTMENTS `array`	Массив идентификаторов отделов, добавленных в группу
IS_PIN `boolean`	Значение `true`/`false` — закреплена ли группа у текущего пользователя на странице групп и проектов
PRIVACY_CODE `string`	Уровень приватности группы: `open` — открытая группа `closed` — закрытая группа `secret` — секретная группа
LIST_OF_MEMBERS `object`	Массив с информацией о пользователях группы (подробное описание)
FEATURES `object`	Массив с информацией об инструментах группы (подробное описание)
LIST_OF_MEMBERS_AWAITING_INVITE `object`	Информация о пользователях, ожидающих подтверждения вступления в группу (подробное описание)
GROUP_MEMBERS_LIST `object`	Информация о связанных с группой пользователями (подробное описание)
COUNTERS `object`	Счетчики (подробное описание)
EFFICIENCY `integer`	Эффективность группы
ADDITIONAL_DATA `object`	Дополнительные данные для текущего пользователя (подробное описание)

Объект AVATAR_TYPES

Название `тип`	Описание
sort `integer`	Сортировка аватара
mobileUrl `string`	URL для отображения аватара в мобильном приложении
webCssClass `string`	CSS-класс аватара
entitySelectorUrl `string`	URL аватара для entity selector

Объект AVATAR_DATA

Название
тип

Описание

type
string

Тип аватара:

icon — системный аватар
image — пользовательское изображение

id
string

Идентификатор аватара:

folder — аватар в виде папки
tasks — аватар в виде чекбокса
chart — аватар в виде графика «пирог»
briefcase — аватар в виде портфеля
group — аватар в виде силуэтов
"" — иной системный аватар
URL — ссылка на сжатый пользовательский аватар, если он установлен

Объект OWNER_DATA

Название `тип`	Описание
ID `user`	Идентификатор владельца группы
PHOTO `string`	URL сжатого аватара владельца группы
FORMATTED_NAME `string`	Отформатированное согласно настройкам портала имя владельца группы

Объект SUBJECT_DATA

Название `тип`	Описание
ID `integer`	Идентификатор тематики
NAME `string`	Название тематики

Объект ACTIONS

Название `тип`	Описание
EDIT `boolean`	Значение `true`/`false` — доступно ли редактирование группы
DELETE `boolean`	Значение `true`/`false` — доступно ли удаление группы
INVITE `boolean`	Значение `true`/`false` — доступно ли приглашение сторонних участников в группу
JOIN `boolean`	Значение `true`/`false` — может ли пользователь присоединиться к группе
LEAVE `boolean`	Значение `true`/`false` — может ли пользователь покинуть группу
FOLLOW `boolean`	Значение `true`/`false` — может ли пользователь подписаться на обновления группы
PIN `boolean`	Значение `true`/`false` — доступно ли закрепление группы
EDIT_FEATURES `boolean`	Значение `true`/`false` — доступно ли изменение инструментов группы

Объект USER_DATA

Название `тип`	Описание
ROLE `any`	Роль пользователя в группе: `A` — владелец группы `E` — модератор группы `K` — участник группы `Z` — ожидает вступления `false` — значение отсутствует
INITIATED_BY_TYPE `any`	Кем инициирована связь пользователя с группой: `U` — пользователем, например пользователь отправил запрос на вступление в группу `G` — группой, например пользователю отправили приглашение `false` — значение отсутствует
IS_SUBSCRIBED `boolean`	Значение `true`/`false` — подписан ли пользователь на обновления группы

Объект LIST_OF_MEMBERS

Название `тип`	Описание
id `user`	Идентификатор пользователя
isOwner `boolean`	Значение `true`/`false` — является ли пользователь владельцем группы
isModerator `boolean`	Значение `true`/`false` — является ли пользователь модератором
isScrumMaster `boolean`	Значение `true`/`false` — является ли пользователь скрам-мастером (для скрам-групп)
isAutoMember `boolean`	Значение `true`/`false` — пользователь добавлен в группу автоматически (без приглашения)
name `string`	Имя пользователя
lastName `string`	Фамилия пользователя
position `string`	Должность пользователя
photo `string`	URL сжатого аватара пользователя

Объект FEATURES

Название `тип`	Описание
featureName `string`	Символьный идентификатор инструмента
name `string`	Название инструмента
customName `string`	Пользовательское название инструмента в расширенных настройках группы
id `string`	Числовой идентификатор инструмента
active `boolean`	Значение `true`/`false` — включен ли инструмент в группе

Объект LIST_OF_MEMBERS_AWAITING_INVITE

Название `тип`	Описание
id `user`	Идентификатор пользователя
name `string`	Отформатированное согласно настройкам портала имя
photo `string`	URL сжатого аватара пользователя

Объект GROUP_MEMBERS_LIST

Название `тип`	Описание
id `user`	Идентификатор участника
invited `boolean`	Значение `true`/`false` — пользователь приглашен
isAwaiting `boolean`	Значение `true`/`false` — пользователь ожидает принятия в группу
isMember `boolean`	Значение `true`/`false` — пользователь является участником группы

Объект COUNTERS

Название `тип`	Описание
workgroup_requests_out `integer`	Текущее количество непринятых приглашений в группу
workgroup_requests_in `integer`	Текущее количество запросов на вступление в группу

Объект ADDITIONAL_DATA

Название
тип

Описание

ROLE
string

Роль текущего пользователя в группе:

A — владелец группы
E — модератор группы
K — участник группы
Z — ожидает вступления
"" — пользователь никак не относится к группе

INITIATED_BY_TYPE
string

Кем инициирована связь пользователя с группой:

U — пользователем, например пользователь отправил запрос на вступление в группу
G — группой, например пользователю отправили приглашение
"" — пользователь никак не относится к группе

Обработка ошибок

HTTP-код: 400

{
            "error": "SONET_CONTROLLER_WORKGROUP_EMPTY",
            "error_description": "Не передано значение ID рабочей группы."
        }

Название `тип`	Описание
error `string`	Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания
error_description `error_description`	Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Код	Описание	Значение
`SONET_CONTROLLER_WORKGROUP_EMPTY`	`Не передано значение ID рабочей группы.`	В массив `params` не передан параметр `groupId`
`SONET_CONTROLLER_WORKGROUP_NOT_FOUND`	`Рабочая группа не найдена.`	Группа по идентификатору `params[groupId]` не найдена или у текущего пользователя нет доступа к ней

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус	Код Текст ошибки	Описание
`500`	`INTERNAL_SERVER_ERROR` Internal server error	Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	Превышен лимит на интенсивность запросов
`429`	`OPERATION_TIME_LIMIT` Method is blocked due to operation time limit	Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	Текущий метод не разрешен для вызова с помощью batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	Превышена максимальная длина параметров, переданных в метод batch
`401`	`NO_AUTH_FOUND` Wrong authorization data	Неверный access-токен или код вебхука
`400`	`INVALID_REQUEST` Https required	Для вызовов методов требуется использовать протокол HTTPS
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	REST API доступен только на коммерческих планах
`403`	`INVALID_CREDENTIALS` Invalid request credentials	У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	Манифест недоступен
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	Запрос требует более высоких привилегий, чем предоставляет токен вебхука
`401`	`expired_token` The access token provided has expired	Предоставленный access-токен доступа истек
`403`	`user_access_error` The user does not have access to the application	Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям
`500`	`PORTAL_DELETED` Portal was deleted	Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Изменить группу или проект

Получить список рабочих групп

Получить данные о рабочей группе socialnetwork.api.workgroup.get

Параметры методаПараметры метода

Параметр paramsПараметр params

Параметр selectПараметр select

Примеры кодаПримеры кода

Обработка ответаОбработка ответа

Возвращаемые данныеВозвращаемые данные

Ключ resultКлюч result

Объект AVATAR_TYPESОбъект AVATAR_TYPES

Объект AVATAR_DATAОбъект AVATAR_DATA

Объект OWNER_DATAОбъект OWNER_DATA

Объект SUBJECT_DATAОбъект SUBJECT_DATA

Объект ACTIONSОбъект ACTIONS

Объект USER_DATAОбъект USER_DATA

Объект LIST_OF_MEMBERSОбъект LIST_OF_MEMBERS

Объект FEATURESОбъект FEATURES

Объект LIST_OF_MEMBERS_AWAITING_INVITEОбъект LIST_OF_MEMBERS_AWAITING_INVITE

Объект GROUP_MEMBERS_LISTОбъект GROUP_MEMBERS_LIST

Объект COUNTERSОбъект COUNTERS

Объект ADDITIONAL_DATAОбъект ADDITIONAL_DATA

Обработка ошибокОбработка ошибок

Возможные коды ошибокВозможные коды ошибок

Статусы и коды системных ошибокСтатусы и коды системных ошибок

Продолжите изучениеПродолжите изучение