метод REST scope: socialnetwork

socialnetwork.api.workgroup.get

Получить данные о рабочей группе

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

Описание

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

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

Параметры

params object обязательный

Параметры запроса для получения группы. Подробнее ниже

Параметр params

groupId integer обязательный

Идентификатор группы. Значение для поля может быть получено методом sonet_group.get

select array необязательный

Список дополнительных полей для извлечения, возвращаемых в result. Подробнее ниже

mode string необязательный

Режим запроса. Может принимать только значение mobile, которое позволяет получить дополнительные данные в массиве result[ADDITIONAL_DATA]

Примеры запроса

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

Ответ

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

Информация о времени выполнения запроса

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

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

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.