Get the list of groups for the current user sonet_group.user.groups

Scope: sonet

Who can execute the method: any user

The method sonet_group.user.groups returns the groups and projects that the current user is a member of.

Method Parameters

No parameters.

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 '{}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sonet_group.user.groups

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/sonet_group.user.groups

try
        {
            const response = await $b24.callMethod(
                'sonet_group.user.groups',
                {}
            );
            
            const result = response.getData().result;
            console.log('Retrieved user groups:', result);
            
            processResult(result);
        }
        catch( error )
        {
            console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'sonet_group.user.groups',
                    []
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error retrieving user groups: ' . $e->getMessage();
        }

BX24.callMethod('sonet_group.user.groups',
            {}, 
            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.user.groups',
            []
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP status: 200

{
            "result": [
                {
                "GROUP_ID": "77",
                "GROUP_NAME": "New Project Title",
                "ROLE": "K",
                "GROUP_IMAGE_ID": null,
                "GROUP_IMAGE": ""
                },
                {
                "GROUP_ID": "79",
                "GROUP_NAME": "Scrum Project",
                "ROLE": "A",
                "GROUP_IMAGE_ID": null,
                "GROUP_IMAGE": ""
                }
            ],
            "time": {
                "start": 1773927027,
                "finish": 1773927028.025164,
                "duration": 1.0251638889312744,
                "processing": 1,
                "date_start": "2026-03-19T16:30:27+02:00",
                "date_finish": "2026-03-19T16:30:28+02:00",
                "operating_reset_at": 1773927627,
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `array`	Array of groups the current user belongs to. An empty array means that the user is not a member of any group or project
GROUP_ID `integer`	Group identifier
GROUP_NAME `string`	Group name
ROLE `string`	Role of the current user. Possible values: `A` — owner `E` — moderator `K` — participant
GROUP_IMAGE_ID `string`	Group avatar identifier
GROUP_IMAGE `string`	URL of the group avatar
IS_EXTRANET `string`	Indicator of an extranet group. This field is returned only for extranet groups: `Y` — extranet group
time `time`	Information about the request execution time

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

Check Current User Permissions

Change Group or Project Owner

Get the list of groups for the current user sonet_group.user.groups

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning