Получить список рабочих групп socialnetwork.api.workgroup.list
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
socialnetworkКто может выполнять метод: любой пользователь
Метод socialnetwork.api.workgroup.list возвращает список рабочих групп, проектов, скрамов и коллаб с учетом прав текущего пользователя.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
filter |
Объект для фильтрации в формате Смотрите ниже список доступных полей для фильтрации. Ключу может быть задан дополнительный префикс, уточняющий поведение фильтра. Возможные значения префикса:
Если в Метод также всегда добавляет фильтр по сайту:
|
|
select |
Массив, содержащий список полей, которые необходимо выбрать. Смотрите ниже список доступных полей для выборки. Если параметр не передан или пуст, выбирается только |
|
order |
Объект сортировки в формате Возможные значения для Возможные значения для
|
|
params |
Дополнительные параметры запроса |
|
start |
Параметр постраничной навигации. Размер страницы результатов — 50 записей. Чтобы получить вторую страницу, передайте Формула: Если передать |
Доступные поля для фильтрации
|
Название |
Описание |
|
ID |
Идентификатор группы |
|
NAME |
Название группы |
|
OWNER_ID |
Идентификатор владельца |
|
ACTIVE |
Признак активности группы: |
|
VISIBLE |
Видимость группы в общем списке: |
|
OPENED |
Открыта ли группа для свободного вступления: |
|
CLOSED |
Находится ли группа в архиве: |
|
PROJECT |
Тип объекта: |
|
SUBJECT_ID |
Идентификатор тематики группы |
|
SITE_ID |
Идентификатор сайта группы |
|
DATE_CREATE |
Дата создания группы |
|
DATE_UPDATE |
Дата изменения группы |
|
DATE_ACTIVITY |
Дата последней активности |
Доступные поля для выборки
|
Название |
Описание |
|
ID |
Идентификатор группы |
|
ACTIVE |
Признак активности группы: |
|
SUBJECT_ID |
Идентификатор тематики группы |
|
NAME |
Название группы |
|
DESCRIPTION |
Описание группы |
|
KEYWORDS |
Ключевые слова группы |
|
CLOSED |
Признак архивной группы: |
|
VISIBLE |
Признак видимости группы: |
|
OPENED |
Признак открытой группы: |
|
PROJECT |
Признак проекта: |
|
LANDING |
Признак группы для публикации: |
|
DATE_CREATE |
Дата создания |
|
DATE_UPDATE |
Дата изменения |
|
DATE_ACTIVITY |
Дата последней активности |
|
IMAGE_ID |
Идентификатор пользовательского аватара |
|
AVATAR_TYPE |
Тип системного аватара |
|
OWNER_ID |
Идентификатор владельца |
|
NUMBER_OF_MEMBERS |
Количество участников |
|
NUMBER_OF_MODERATORS |
Количество модераторов |
|
INITIATE_PERMS |
Кто может приглашать участников:
|
|
PROJECT_DATE_START |
Дата начала проекта |
|
PROJECT_DATE_FINISH |
Дата окончания проекта |
|
SCRUM_OWNER_ID |
Идентификатор владельца скрама |
|
SCRUM_MASTER_ID |
Идентификатор скрам-мастера |
|
SCRUM_SPRINT_DURATION |
Длительность спринта в секундах |
|
SCRUM_TASK_RESPONSIBLE |
Ответственный по умолчанию в скраме:
|
|
TYPE |
Тип группы: |
|
AVATAR |
URL аватара |
Параметр params
|
Название |
Описание |
|
IS_ADMIN |
Отключение проверки прав. Возможные значения:
Если передан |
|
siteId |
Идентификатор сайта, который будет подставлен в автоматический фильтр Для экстранет-пользователей это значение игнорируется: метод всегда использует экстранет-сайт |
|
mode |
Режим ответа. Поддерживаемое значение:
Поле
|
|
features |
Список кодов инструментов группы, которые нужно учитывать при формировании |
|
mandatoryFeatures |
Коды инструментов из |
|
shouldSelectHasCollabers |
Добавлять ли в Возможные значения:
По умолчанию — |
|
shouldEnsureHasCollabers |
Пересчитать ли признак Параметр учитывается, только если Возможные значения:
По умолчанию — |
|
shouldSelectDialogId |
Добавлять ли в элемент списка поле с идентификатором чата Возможные значения:
По умолчанию — |
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"filter":{"ACTIVE":"Y","CLOSED":"N","%NAME":"группа"},"select":["ID","NAME","TYPE","AVATAR"],"order":{"ID":"DESC"},"params":{"mode":"mobile","shouldSelectDialogId":"Y"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/socialnetwork.api.workgroup.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"filter":{"ACTIVE":"Y","CLOSED":"N","%NAME":"группа"},"select":["ID","NAME","TYPE","AVATAR"],"order":{"ID":"DESC"},"params":{"mode":"mobile","shouldSelectDialogId":"Y"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/socialnetwork.api.workgroup.list
// 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 } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of the payload returned in result (match the "response handling" section of the page)
type WorkgroupListResult = {
workgroups: Workgroup[]
}
type Workgroup = {
id: number
name: string
type: 'group' | 'project' | 'scrum' | 'collab' | null
imageId: number
avatarType: string | null
avatar: string
additionalData: {
role: string
initiatedByType: string
features?: string[]
hasCollabers?: boolean
}
dialogId: string
}
try {
// socialnetwork.api.workgroup.list 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<WorkgroupListResult>({
method: 'socialnetwork.api.workgroup.list',
params: {
filter: { ACTIVE: 'Y', CLOSED: 'N', '%NAME': 'group' },
select: ['ID', 'NAME', 'TYPE', 'AVATAR'],
order: { ID: 'DESC' },
params: { mode: 'mobile', shouldSelectDialogId: 'Y' },
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('Workgroups:', result.workgroups.length, result.workgroups)
}
} 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 fetchWorkgroupList() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
// socialnetwork.api.workgroup.list 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: 'socialnetwork.api.workgroup.list',
params: {
filter: { ACTIVE: 'Y', CLOSED: 'N', '%NAME': 'group' },
select: ['ID', 'NAME', 'TYPE', 'AVATAR'],
order: { ID: 'DESC' },
params: { mode: 'mobile', shouldSelectDialogId: 'Y' },
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('Workgroups:', result.workgroups.length, result.workgroups)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', fetchWorkgroupList)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.socialnetwork.api.workgroup.list(
filter={
"ACTIVE": "Y",
"CLOSED": "N",
"%NAME": "группа",
},
select=[
"ID",
"NAME",
"TYPE",
"AVATAR",
],
order={
"ID": "DESC",
},
params={
"mode": "mobile",
"shouldSelectDialogId": "Y",
},
).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}")
Пример as_list
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.socialnetwork.api.workgroup.list(
filter={
"ACTIVE": "Y",
"CLOSED": "N",
"%NAME": "группа",
},
select=[
"ID",
"NAME",
"TYPE",
"AVATAR",
],
order={
"ID": "DESC",
},
params={
"mode": "mobile",
"shouldSelectDialogId": "Y",
},
).as_list().response
result = bitrix_response.result
for item in result:
print(item)
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}")
Пример as_list_fast
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.socialnetwork.api.workgroup.list(
filter={
"ACTIVE": "Y",
"CLOSED": "N",
"%NAME": "группа",
},
select=[
"ID",
"NAME",
"TYPE",
"AVATAR",
],
order={
"ID": "DESC",
},
params={
"mode": "mobile",
"shouldSelectDialogId": "Y",
},
).as_list_fast(descending=True).response
result = bitrix_response.result
for item in result:
print(item)
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(
'socialnetwork.api.workgroup.list',
[
'filter' => ['ACTIVE' => 'Y', 'CLOSED' => 'N', '%NAME' => 'группа'],
'select' => ['ID', 'NAME', 'TYPE', 'AVATAR'],
'order' => ['ID' => 'DESC'],
'params' => [
'mode' => 'mobile',
'shouldSelectDialogId' => 'Y',
],
]
);
print_r($response->getResponseData()->getResult());
} catch (\Throwable $exception) {
echo $exception->getMessage();
}
BX24.callMethod(
'socialnetwork.api.workgroup.list',
{
filter: { ACTIVE: 'Y', CLOSED: 'N', '%NAME': 'группа' },
select: ['ID', 'NAME', 'TYPE', 'AVATAR'],
order: { ID: 'DESC' },
params: { mode: 'mobile', shouldSelectDialogId: 'Y' }
},
function(result) {
if (result.error()) {
console.error(result.error());
} else {
console.log(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'socialnetwork.api.workgroup.list',
[
'filter' => ['ACTIVE' => 'Y', 'CLOSED' => 'N', '%NAME' => 'группа'],
'select' => ['ID', 'NAME', 'TYPE', 'AVATAR'],
'order' => ['ID' => 'DESC'],
'params' => [
'mode' => 'mobile',
'shouldSelectDialogId' => 'Y',
],
]
);
print_r($result);
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "socialnetwork.api.workgroup.list", b24.Params{
"filter": b24.Params{
"ACTIVE": "Y",
"CLOSED": "N",
"%NAME": "группа",
},
"select": []string{"ID", "NAME", "TYPE", "AVATAR"},
"order": b24.Params{
"ID": "DESC",
},
"params": b24.Params{
"mode": "mobile",
"shouldSelectDialogId": "Y",
},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("socialnetwork.api.workgroup.list: %w", err)
}
// Метод заворачивает ответ в объект с ключом "workgroups".
raw, ok := b24.Unwrap(res.Result, "workgroups")
if !ok {
return fmt.Errorf("в ответе нет ключа workgroups")
}
var items []struct {
ID b24.ID `json:"id"`
Name string `json:"name"`
Type string `json:"type"`
ImageID b24.ID `json:"imageId"`
Avatar string `json:"avatar"`
DialogID string `json:"dialogId"`
}
if err := json.Unmarshal(raw, &items); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
for _, it := range items {
fmt.Println(it.ID)
}
Обработка ответа
HTTP-статус: 200
{
"result": {
"workgroups": [
{
"id": 5,
"name": "Открытая группа для всех",
"type": "group",
"imageId": 5,
"avatarType": null,
"avatar": "https://test.bitrix24.ru/b13743910/resize_cache/5/7acf4caaf5d8/socialnetwork/8d6/8d2c04ece929572/3.png",
"additionalData": {
"role": "",
"initiatedByType": ""
},
"dialogId": ""
},
{
"id": 1,
"name": "Закрытая видимая группа",
"type": "group",
"imageId": 1,
"avatarType": null,
"avatar": "",
"additionalData": {
"role": "",
"initiatedByType": ""
},
"dialogId": "chat177"
}
]
},
"total": 2,
"time": {
"start": 1774357689,
"finish": 1774357689.398272,
"duration": 0.3982720375061035,
"processing": 0,
"date_start": "2026-03-24T16:08:09+03:00",
"date_finish": "2026-03-24T16:08:09+03:00",
"operating_reset_at": 1774358289,
"operating": 0.12220001220703125
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Корневой объект ответа |
|
workgroups |
Список рабочих групп с описанием полей. Состав объекта зависит от переданных полей в Если группы по фильтру не найдены, |
|
next |
Смещение для следующей страницы. Поле возвращается, если есть еще записи |
|
total |
Общее число записей. Поле не возвращается, если запрос выполнен со |
|
time |
Информация о времени выполнения запроса |
Поля объекта workgroup
Поля для выборки передаются в select в формате UPPER_SNAKE_CASE, а в ответе возвращаются в формате camelCase. Например, DATE_CREATE соответствует dateCreate, а NUMBER_OF_MEMBERS — numberOfMembers.
|
Поле ответа |
Поле в select или условие возврата |
Описание |
|
id |
|
Идентификатор группы. Возвращается всегда |
|
active |
|
Признак активности группы: |
|
subjectId |
|
Идентификатор тематики группы |
|
name |
|
Название группы |
|
description |
|
Описание группы |
|
keywords |
|
Ключевые слова группы |
|
closed |
|
Признак архивной группы: |
|
visible |
|
Признак видимости группы: |
|
opened |
|
Признак открытой группы: |
|
project |
|
Признак проекта: |
|
landing |
|
Признак группы для публикации: |
|
dateCreate |
|
Дата создания группы |
|
dateUpdate |
|
Дата изменения группы |
|
dateActivity |
|
Дата последней активности |
|
imageId |
|
Идентификатор пользовательского аватара |
|
avatarType |
|
Тип системного аватара |
|
avatar |
|
URL аватара. Если аватар не задан, возвращается пустая строка |
|
ownerId |
|
Идентификатор владельца |
|
numberOfMembers |
|
Количество участников |
|
numberOfModerators |
|
Количество модераторов |
|
initiatePerms |
|
Кто может приглашать участников: |
|
projectDateStart |
|
Дата начала проекта |
|
projectDateFinish |
|
Дата окончания проекта |
|
scrumOwnerId |
|
Идентификатор владельца скрама |
|
scrumMasterId |
|
Идентификатор скрам-мастера |
|
scrumSprintDuration |
|
Длительность спринта в секундах |
|
scrumTaskResponsible |
|
Ответственный по умолчанию: |
|
type |
|
Тип группы: |
|
additionalData |
|
Дополнительные данные о группе и текущем пользователе (подробное описание) |
|
dialogId |
|
Идентификатор чата группы. Если чат не найден, возвращается пустая строка |
Объект additionalData
|
Название |
Описание |
|
role |
Роль текущего пользователя в группе. Если пользователь не связан с группой, возвращается пустая строка |
|
initiatedByType |
Кто инициировал связь пользователя с группой:
Если пользователь не связан с группой, возвращается пустая строка |
|
features |
Коды доступных инструментов группы. Поле возвращается, если в |
|
hasCollabers |
Есть ли в группе внешние участники. Поле возвращается, если |
Обработка ошибок
HTTP-статус: 401
{
"error": "insufficient_scope",
"error_description": "The request requires higher privileges than provided by the webhook token"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только |
|
error_description |
Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки |
Возможные коды ошибок
|
Код |
Описание |
Значение |
|
|
Недостаточно скоупа у токена |
Токен не содержит скоуп |
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |