метод REST scope: sonet

sonet_group.get

Получить список групп и проектов

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

Описание

Метод sonet_group.get возвращает список рабочих групп и проектов с учетом прав текущего пользователя.

Параметры

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

Направление сортировки.

Возможные значения:
- ASC — сортировка по возрастанию
- DESC — сортировка по убыванию

По умолчанию — ID:'DESC'

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

Объект для фильтрации в формате {"field_1": "value_1", ... "field_N": "value_N"}.

Смотрите ниже список доступных полей для фильтрации.

Поддерживаемые операторы в ключе фильтра:
- ! — не равно
- >= — больше либо равно
- > — больше
- <= — меньше либо равно
- < — меньше
- >< — между (диапазон, включительно)
- !>< — не между (вне диапазона)
- ? — поиск по строке
- = — равно, точное совпадение (используется по умолчанию)
- != — не равно
- % — LIKE, поиск по подстроке
- !% — NOT LIKE, поиск по подстроке

По умолчанию — без фильтрации

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

Вернуть группу или проект по идентификатору.

Если параметр передан, метод добавляет в фильтр условие ID = GROUP_ID

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

Отключение проверки прав.

Возможные значения:
- Y — отключить проверку прав, если текущий пользователь администратор

Если передан Y не администратором, значение игнорируется.

По умолчанию — проверка прав включена

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

Параметр постраничной навигации.

Размер страницы результатов — 50 записей.

Чтобы получить вторую страницу, передайте 50; третью — 100 и так далее.

Формула:

start = (N - 1) * 50, где N — номер страницы

Доступные поля для фильтрации

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

Идентификатор группы или проекта

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

Название группы или проекта

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

Идентификатор владельца

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

Признак активности группы.

Возможные значения:
- Y — группа активна
- N — группа деактивирована

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

Видимость группы в списке.

Возможные значения:
- Y — группа видна в общем списке
- N — группа скрыта из общего списка

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

Открыта ли группа для свободного вступления.

Возможные значения:
- Y — пользователь может вступить в группу без подтверждения
- N — вступление по приглашению или запросу

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

Архивная ли группа.

Возможные значения:
- Y — группа в архиве
- N — активная группа

DATE_CREATE datetime необязательный

Дата создания группы в формате ISO-8601

DATE_UPDATE datetime необязательный

Дата изменения группы в формате ISO-8601

DATE_ACTIVITY datetime необязательный

Дата последней активности в группе в формате ISO-8601

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

Фильтр по типу сайта группы.

Возможные значения:
- Y — экстранет-группы
- N — не экстранет-группы

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"ORDER":{"NAME":"ASC"},"FILTER":{"%NAME":"Про"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sonet_group.get

Ответ

HTTP-статус: 200

{
    "result": [
        {
        "ID": "77",
        "SITE_ID": "s1",
        "NAME": "Новый заголовок проекта",
        "DESCRIPTION": null,
        "DATE_CREATE": "2026-03-19T15:01:27+03:00",
        "DATE_UPDATE": "2026-03-19T15:01:27+03:00",
        "ACTIVE": "Y",
        "VISIBLE": "Y",
        "OPENED": "N",
        "CLOSED": "N",
        "SUBJECT_ID": "1",
        "OWNER_ID": "1271",
        "KEYWORDS": null,
        "NUMBER_OF_MEMBERS": "12",
        "DATE_ACTIVITY": "2026-03-19T15:01:27+03:00",
        "SUBJECT_NAME": "Рабочие группы",
        "PROJECT": "Y",
        "IS_EXTRANET": "N"
        },
        {
        "ID": "79",
        "SITE_ID": "s1",
        "NAME": "Скрам-проект",
        "DESCRIPTION": null,
        "DATE_CREATE": "2026-03-19T15:15:06+03:00",
        "DATE_UPDATE": "2026-03-19T15:15:06+03:00",
        "ACTIVE": "Y",
        "VISIBLE": "Y",
        "OPENED": "N",
        "CLOSED": "N",
        "SUBJECT_ID": "1",
        "OWNER_ID": "1269",
        "KEYWORDS": null,
        "NUMBER_OF_MEMBERS": "8",
        "DATE_ACTIVITY": "2026-03-19T15:15:06+03:00",
        "SUBJECT_NAME": "Рабочие группы",
        "PROJECT": "Y",
        "IS_EXTRANET": "N"
        }
    ],
    "total": 2,
    "time": {
        "start": 1773925430,
        "finish": 1773925430.419962,
        "duration": 0.41996192932128906,
        "processing": 0,
        "date_start": "2026-03-19T16:03:50+03:00",
        "date_finish": "2026-03-19T16:03:50+03:00",
        "operating_reset_at": 1773926030,
        "operating": 0
    }
}

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

result object

Массив групп и проектов, соответствующих условиям FILTER.

Пустой массив означает, что подходящие записи с учетом прав доступа текущего пользователя отсутствуют

ID integer

Идентификатор группы

SITE_ID string

Идентификатор сайта группы

NAME string

Название группы

DESCRIPTION string

Описание группы

DATE_CREATE datetime

Дата создания группы в формате ISO-8601

DATE_UPDATE datetime

Дата изменения группы в формате ISO-8601

DATE_ACTIVITY datetime

Дата последней активности в формате ISO-8601

ACTIVE string

Признак активности

VISIBLE string

Видимость группы

OPENED string

Открыта ли группа

CLOSED string

Архивная ли группа

SUBJECT_ID integer

Идентификатор тематики группы

OWNER_ID integer

Идентификатор владельца

KEYWORDS string

Ключевые слова группы

NUMBER_OF_MEMBERS integer

Количество участников

SUBJECT_NAME string

Название тематики группы

IMAGE string

URL аватара группы

IS_EXTRANET string

Признак экстранет-группы

total integer

Общее количество элементов в выборке

next integer

Смещение следующей страницы (если есть)

time time

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

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

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