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

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: sonet

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

Метод 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
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"ORDER":{"NAME":"ASC"},"FILTER":{"%NAME":"Про"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sonet_group.get
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame, ISODate } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

// Shape of each SonetGroup returned in result[]
type SonetGroup = {
  ID: string
  SITE_ID: string
  NAME: string
  DESCRIPTION: string | null
  DATE_CREATE: ISODate
  DATE_UPDATE: ISODate
  DATE_ACTIVITY: ISODate
  ACTIVE: string
  VISIBLE: string
  OPENED: string
  CLOSED: string
  SUBJECT_ID: string
  OWNER_ID: string
  KEYWORDS: string | null
  NUMBER_OF_MEMBERS: string
  SUBJECT_NAME: string
  PROJECT: string
  IS_EXTRANET: string
}

try {
  // sonet_group.get returns a single page (max 50 records). For the whole result set
  // use a list helper: $b24.actions.v2.callList.make() returns every record as one
  // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
  // NOTE: the list helpers do not accept `order` (it is excluded from their params, so
  // passing it is a TS error) — keep this call.make + `start` variant when sort matters.
  const response = await $b24.actions.v2.call.make<SonetGroup[]>({
    method: 'sonet_group.get',
    params: {
      ORDER: { NAME: 'ASC' },
      FILTER: { '%NAME': 'Про' },
      start: 0,
    },
    requestId: Text.getUuidRfc4122()
  })

  // The payload is available only on a successful response
  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info('Retrieved groups:', result.length, result[0]?.NAME)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function getGroups() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      // sonet_group.get returns a single page (max 50 records). For the whole result set
      // use a list helper: $b24.actions.v2.callList.make() returns every record as one
      // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
      // NOTE: the list helpers do not accept `order` (it is excluded from their params, so
      // passing it is a TS error) — keep this call.make + `start` variant when sort matters.
      const response = await $b24.actions.v2.call.make({
        method: 'sonet_group.get',
        params: {
          ORDER: { NAME: 'ASC' },
          FILTER: { '%NAME': 'Про' },
          start: 0,
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

      // The payload is available only on a successful response
      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info('Retrieved groups:', result.length, result[0]?.NAME)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', getGroups)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.sonet_group.get(
        order={
            "NAME": "ASC",
        },
        filter={
            "%NAME": "Про",
        },
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")
try {
    $response = $b24Service
        ->core
        ->call(
            'sonet_group.get',
            [
                'ORDER' => ['NAME' => 'ASC'],
                'FILTER' => ['%NAME' => 'Про']
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    echo 'Success: ' . print_r($result, true);
    processData($result);

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error retrieving groups: ' . $e->getMessage();
}
BX24.callMethod('sonet_group.get', {
    ORDER: { NAME: 'ASC' },
    FILTER: { '%NAME': 'Про' }
}, function(result) {
    if (result.error())
    {
        console.error(result.error(), result.error_description());
    }
    else
    {
        console.log(result.data());
    }
});
require_once('crest.php');

$result = CRest::call(
    'sonet_group.get',
    [
        'ORDER' => ['NAME' => 'ASC'],
        'FILTER' => ['%NAME' => 'Про']
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "sonet_group.get", b24.Params{
	"ORDER": b24.Params{
		"NAME": "ASC",
	},
	"FILTER": b24.Params{
		"%NAME": "Про",
	},
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("sonet_group.get: %w", err)
}

var items []struct {
	ID         b24.ID `json:"ID"`
	SiteID     string `json:"SITE_ID"`
	Name       string `json:"NAME"`
	DateCreate string `json:"DATE_CREATE"`
	DateUpdate string `json:"DATE_UPDATE"`
	Active     string `json:"ACTIVE"`
}
if err := json.Unmarshal(res.Result, &items); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
for _, it := range items {
	fmt.Println(it.ID, it.SiteID)
}

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

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 (подробное описание).

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

total
integer

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

next
integer

Смещение следующей страницы. Поле отсутствует, если получена последняя страница

time
time

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

Объект result

Название
тип

Описание

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

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

PROJECT
string

Признак проекта. Возможные значения:

  • Y — проект
  • N — группа

IMAGE
string

URL аватара группы. Поле присутствует, если у группы задан аватар

IS_EXTRANET
string

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

  • Y — экстранет-группа
  • N — группа не относится к экстранету

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

Метод не возвращает специфичных ошибок.

Название
тип

Описание

error
string

Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только error_description

error_description
string

Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки

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

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

Код
Текст ошибки

Описание

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

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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