# socialnetwork.api.workgroup.get

URL: https://chugunov.pro/api-bitrix24/sonet-group/socialnetwork-api-workgroup-get/
Проверено на Битрикс24 REST API, обновлено 11.09.2026 (ревизия источника fb39d6c).
Источник: официальная документация Битрикс24 (bitrix-tools/b24-rest-docs, лицензия MIT, © Bitrix). Справочник независимый, официальной документацией не является.

Получить данные о рабочей группе
Scope: `socialnetwork`
Кто может выполнять метод: любой пользователь

## Описание

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

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

## Параметры

- `params` `object` — обязательный. Параметры запроса для получения группы. Подробнее [ниже](#params)

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

- `groupId` `integer` — обязательный. Идентификатор группы. Значение для поля может быть получено методом [sonet_group.get](https://chugunov.pro/api-bitrix24/sonet-group/sonet-group-get/)
- `select` `array` — необязательный. Список дополнительных полей для извлечения, возвращаемых в `result`. Подробнее [ниже](#paramsselect)
- `mode` `string` — необязательный. Режим запроса. Может принимать только значение `mobile`, которое позволяет получить дополнительные данные в массиве `result[ADDITIONAL_DATA]`

## Ответ

HTTP-статус: 200

```json
{
    "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`. Результат выполнения запроса. Подробнее [ниже](#result)
- `time` `time`. Информация о времени выполнения запроса

## Ошибки

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

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

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

### cURL (Webhook)

```bash
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 (OAuth)

```bash
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
```

### JS (TS)

```ts
// 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 WorkgroupGetResult = {
  ID: number
  ACTIVE: string
  NAME: string
  DESCRIPTION: string
  CLOSED: string
  VISIBLE: string
  OPENED: string
  DATE_CREATE: string
  DATE_UPDATE: string
  DATE_ACTIVITY: string
  AVATAR_TYPE: string
  OWNER_ID: number
  INITIATE_PERMS: string
  NUMBER_OF_MEMBERS: number
  NUMBER_OF_MODERATORS: number
  PROJECT: string
  PROJECT_DATE_START: string | null
  PROJECT_DATE_FINISH: string | null
  TYPE: string
  MEMBERS: number[]
  CHAT_ID: number
  DIALOG_ID: string
  ORDINARY_MEMBERS: number[]
  INVITED_MEMBERS: number[]
  MODERATOR_MEMBERS: number[]
  SITE_IDS: string[]
  TAGS: string[]
  DEPARTMENTS: number[]
}

try {
  const response = await $b24.actions.v2.call.make<WorkgroupGetResult>({
    method: 'socialnetwork.api.workgroup.get',
    params: {
      params: {
        groupId: 622,
        select: ['DEPARTMENTS', 'TAGS'],
      },
    },
    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(result.ID, result.NAME, result.TYPE, result.TAGS, result.DEPARTMENTS)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}
```

### JS (UMD)

```html
<!-- 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 getWorkgroup() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'socialnetwork.api.workgroup.get',
        params: {
          params: {
            groupId: 622,
            select: ['DEPARTMENTS', 'TAGS'],
          },
        },
        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(result.ID, result.NAME, result.TYPE, result.TAGS, result.DEPARTMENTS)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', getWorkgroup)
</script>
```

### Python

```python
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.socialnetwork.api.workgroup.get(
        params={
            "groupId": 622,
            "select": [
                "DEPARTMENTS",
                "TAGS",
            ],
        },
    ).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}")
```

### PHP

```php
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.js

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

### PHP CRest

```php
require_once('crest.php');

$result = CRest::call(
    'socialnetwork.api.workgroup.get',
    [
        'params' => [
            'groupId' => 622,
            'select' => ['DEPARTMENTS', 'TAGS']
        ]
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
```

### Go

```go
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "socialnetwork.api.workgroup.get", b24.Params{
	"params": b24.Params{
		"groupId": 622,
		"select":  []string{"DEPARTMENTS", "TAGS"},
	},
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("socialnetwork.api.workgroup.get: %w", err)
}

var item struct {
	ID          b24.ID `json:"ID"`
	Active      string `json:"ACTIVE"`
	SiteID      string `json:"SITE_ID"`
	SubjectID   b24.ID `json:"SUBJECT_ID"`
	Name        string `json:"NAME"`
	Description string `json:"DESCRIPTION"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.ID, item.Active)
```

Оригинал в официальной документации: https://apidocs.bitrix24.ru/api-reference/sonet-group/socialnetwork-api-workgroup-get.html