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: string
  name: string
  type: string
  avatar: string
  additionalData: {
    role: string
    initiatedByType: string
  }
  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}")

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}")

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)
}