Get a list of groups and projects sonet_group.get

Choose a tool for developing with an AI agent:

  • use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
  • use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation

Scope: sonet

Who can execute the method: any user

The method sonet_group.get returns a list of workgroups and projects considering the permissions of the current user.

Method Parameters

Required parameters are marked with *

Name
type

Description

ORDER
object

Sorting direction.

Possible values:

  • ASC — ascending order
  • DESC — descending order

Default — ID:'DESC'

FILTER
object

Object for filtering in the format {"field_1": "value_1", ... "field_N": "value_N"}.

See below list of available fields for filtering.

Supported operators in the filter key:

  • ! — not equal
  • >= — greater than or equal
  • > — greater than
  • <= — less than or equal
  • < — less than
  • >< — between (inclusive range)
  • !>< — not between (outside the range)
  • ? — string search
  • = — equal, exact match (used by default)
  • != — not equal
  • % — LIKE, substring search
  • !% — NOT LIKE, substring search

Default — no filtering

GROUP_ID
integer

Return group or project by identifier.

If the parameter is provided, the method adds the filter condition ID = GROUP_ID

IS_ADMIN
string

Disable permission check.

Possible values:

  • Y — disable permission check if the current user is an administrator

If Y is provided by a non-administrator, the value is ignored.

Default — permission check is enabled

start
integer

Pagination parameter.

The page size of results is 50 records.

To get the second page, pass 50; the third — 100, and so on.

Formula:

start = (N - 1) * 50, where N — page number

Available fields for filtering

Name
type

Description

ID
integer

Identifier of the group or project

NAME
string

Name of the group or project

OWNER_ID
integer

Identifier of the owner

ACTIVE
string

Activity status of the group.

Possible values:

  • Y — group is active
  • N — group is deactivated

VISIBLE
string

Visibility of the group in the list.

Possible values:

  • Y — group is visible in the general list
  • N — group is hidden from the general list

OPENED
string

Is the group open for free membership.

Possible values:

  • Y — user can join the group without confirmation
  • N — membership by invitation or request

CLOSED
string

Is the group archived.

Possible values:

  • Y — group is archived
  • N — active group

DATE_CREATE
datetime

Creation date of the group in ISO-8601 format

DATE_UPDATE
datetime

Modification date of the group in ISO-8601 format

DATE_ACTIVITY
datetime

Date of last activity in the group in ISO-8601 format

IS_EXTRANET
string

Filter by the type of the group's site.

Possible values:

  • Y — extranet groups
  • N — non-extranet groups

Code Examples

How to Use Examples in Documentation

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"ORDER":{"NAME":"ASC"},"FILTER":{"%NAME":"Pro"}}' \
        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":"Pro"},"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': 'Pro' },
              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': 'Pro' },
                  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": "Pro",
                },
            ).response
            result = bitrix_response.result
            print(result)
        except BitrixAPIError as error:
            print(
                "Bitrix API error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        except Exception as error:
            print(f"Unexpected error: {error}")
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'sonet_group.get',
                    [
                        'ORDER' => ['NAME' => 'ASC'],
                        'FILTER' => ['%NAME' => 'Pro']
                    ]
                );
        
            $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': 'Pro' }
        }, 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' => 'Pro']
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        
// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "sonet_group.get", b24.Params{
        	"ORDER": b24.Params{
        		"NAME": "ASC",
        	},
        	"FILTER": b24.Params{
        		"%NAME": "Pro",
        	},
        }, 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("parse response: %w", err)
        }
        for _, it := range items {
        	fmt.Println(it.ID, it.SiteID)
        }
        

Response Handling

HTTP status: 200

{
            "result": [
                {
                "ID": "77",
                "SITE_ID": "s1",
                "NAME": "New Project Title",
                "DESCRIPTION": null,
                "DATE_CREATE": "2026-03-19T15:01:27+02:00",
                "DATE_UPDATE": "2026-03-19T15:01:27+02: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+02:00",
                "SUBJECT_NAME": "Workgroups",
                "PROJECT": "Y",
                "IS_EXTRANET": "N"
                },
                {
                "ID": "79",
                "SITE_ID": "s1",
                "NAME": "Scrum Project",
                "DESCRIPTION": null,
                "DATE_CREATE": "2026-03-19T15:15:06+02:00",
                "DATE_UPDATE": "2026-03-19T15:15:06+02: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+02:00",
                "SUBJECT_NAME": "Workgroups",
                "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+02:00",
                "date_finish": "2026-03-19T16:03:50+02:00",
                "operating_reset_at": 1773926030,
                "operating": 0
            }
        }
        

Returned Data

Name
type

Description

result
object

Array of groups and projects that match the FILTER conditions.

An empty array means that there are no suitable records considering the access permissions of the current user

ID
integer

Identifier of the group

SITE_ID
string

Identifier of the group's site

NAME
string

Name of the group

DESCRIPTION
string

Description of the group

DATE_CREATE
datetime

Creation date of the group in ISO-8601 format

DATE_UPDATE
datetime

Modification date of the group in ISO-8601 format

DATE_ACTIVITY
datetime

Date of last activity in ISO-8601 format

ACTIVE
string

Activity status

VISIBLE
string

Visibility of the group

OPENED
string

Is the group open

CLOSED
string

Is the group archived

SUBJECT_ID
integer

Identifier of the group's subject

OWNER_ID
integer

Identifier of the owner

KEYWORDS
string

Keywords of the group

NUMBER_OF_MEMBERS
integer

Number of members

SUBJECT_NAME
string

Name of the group's subject

IMAGE
string

URL of the group's avatar

IS_EXTRANET
string

Indicator of the extranet group

total
integer

Total number of items in the selection

next
integer

Offset for the next page (if any)

time
time

Information about the execution time of the request

Error Handling

Statuses and System Error Codes

HTTP Status: 4xx, 5xx

The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.

Status

Code
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit

401

NO_AUTH_FOUND
Wrong authorization data

The request contains no authorization data: neither an access token nor a webhook code was passed

401

INVALID_REQUEST
Https required

Methods are called over the HTTPS protocol only

401

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support

401

ACCESS_DENIED
REST is available only on commercial plans

REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

No active webhook with the specified user identifier and secret code was found

404

ERROR_METHOD_NOT_FOUND
Method not found!

No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope

401

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

The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with provided by the access token

401

expired_token
The access token provided has expired

The access token has expired

401

user_access_error
The user does not have access to the application

The application is installed, but the Bitrix24 administrator has granted access to it only to specific users

403

PORTAL_DELETED
Portal was deleted

The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning