Get a list of groups and projects sonet_group.get

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 (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

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

try
        {
            const response = await $b24.callMethod(
                'sonet_group.get',
                {
                    ORDER: { NAME: 'ASC' },
                    FILTER: { '%NAME': 'Pro' }
                }
            );
            
            const result = response.getData().result;
            console.log('Retrieved groups:', result);
            
            processResult(result);
        }
        catch( error )
        {
            console.error('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>';

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: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not allowed to be called using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Get List of Workgroups

Check Current User Permissions

Get a list of groups and projects sonet_group.get

Method ParametersMethod Parameters

Available fields for filteringAvailable fields for filtering

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning