Retrieve Data on Workgroup socialnetwork.api.workgroup.get

If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.

Scope: socialnetwork

Who can execute the method: any user

The method socialnetwork.api.workgroup.get returns information about a workgroup, project, scrum, or collaboration based on the identifier.

An administrator can retrieve information about any group on the account, even if it is secret and they are not a member.

Method Parameters

Required parameters are marked with *

Name `type`	Description
params* `object`	Request parameters for retrieving the group. More details below

Parameter params

Required parameters are marked with *

Name `type`	Description
groupId* `integer`	Group identifier. The value for this field can be obtained using the method sonet_group.get
select `array`	List of additional fields to retrieve, returned in `result`. More details below
mode `string`	Request mode. Can only take the value `mobile`, which allows retrieving additional data in the array `result[ADDITIONAL_DATA]`

Parameter select

Name `type`	Description
ACTIONS `string`	Operations available to the current user on the group
AVATAR `string`	URL of the group's compressed user avatar
AVATAR_DATA `string`	Information about the group's avatar
AVATAR_TYPES `string`	Types of avatars for groups
COUNTERS `string`	Number of unaccepted requests and invitations to join the group
DATE_CREATE `string`	Date and time of group creation in a more readable format
DEPARTMENTS `string`	Departments of employees added to the group
EFFICIENCY `string`	Group efficiency
FEATURES `string`	Available tools in the group specified in the advanced group settings
GROUP_MEMBERS_LIST `string`	List of active group members, invited users, and users awaiting confirmation to join the group
LIST_OF_MEMBERS `string`	List of group members with their information
LIST_OF_MEMBERS_AWAITING_INVITE `string`	Users awaiting confirmation to join the group
OWNER_DATA `string`	Data about the group owner
PIN `string`	Whether the group is pinned for the current user on the groups and projects page. Returned as `result[IS_PIN]`
PRIVACY_TYPE `string`	Group privacy level. Returned as `result[PRIVACY_CODE]`
SUBJECT_DATA `string`	Information about the group's subject specified in the advanced group settings
TAGS `string`	Group tags specified in the advanced group settings
USER_DATA `string`	Data about the current user's role in the group

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 '{"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 -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

try
        {
        	const response = await $b24.callMethod(
        		'socialnetwork.api.workgroup.get',
        		{
        			params: {
        				groupId: 622,
        				select: [ 'DEPARTMENTS', 'TAGS' ],
        			},
        		}
        	);
        	
        	const result = response.getData().result;
        	console.log(result);
        }
        catch( error )
        {
        	console.error('Error:', error);
        }

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.callMethod(
            'socialnetwork.api.workgroup.get', {
            params: {
                groupId: 622,
                select: [ 'DEPARTMENTS', 'TAGS' ],
            },
        }, result => {
            console.log(result);
        });

require_once('crest.php');
        
        $result = CRest::call(
            'socialnetwork.api.workgroup.get',
            [
                'params' => [
                    'groupId' => 622,
                    'select' => ['DEPARTMENTS', 'TAGS']
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

How to Use Examples in Documentation

Response Handling

HTTP Status: 200

{
            "result": {
                "ID": 622,
                "ACTIVE": "Y",
                "SITE_ID": "s1",
                "SUBJECT_ID": 1,
                "NAME": "Group for Demonstrating the Method",
                "DESCRIPTION": "First line of the group description\r\nSecond line of the group description",
                "KEYWORDS": "group tag, another group tag",
                "CLOSED": "N",
                "VISIBLE": "Y",
                "OPENED": "N",
                "DATE_CREATE": "04/17/2025 19:37:55",
                "DATE_UPDATE": "04/17/2025 19:40:48",
                "DATE_ACTIVITY": "04/17/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": "Group for Demonstrating the Method First line of the group description\r\nSecond line of the group description group tag #group tag another group tag #another group tag 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": [
                    "another group tag",
                    "group tag"
                ],
                "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+02:00",
                "date_finish": "2025-04-17T19:41:14+02:00",
                "operating_reset_at": 1744908674,
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `object`	Result of the request execution. More details below
time `time`	Information about the request execution time

Key result

Name `type`	Description
ID `integer`	Group identifier
ACTIVE `boolean`	Flag `Y`/`N` — whether the group is active. The group can be activated or deactivated using the method sonet_group.update
SITE_ID `string`	Identifier of the site to which the group belongs
SUBJECT_ID `integer`	Identifier of the group's subject. The subject of the group is specified in the advanced group settings
NAME `string`	Group name
DESCRIPTION `text`	Group description
KEYWORDS `string`	Group tags separated by commas: `tag1,tag2`
CLOSED `boolean`	Flag `Y`/`N` — whether the group is archived
VISIBLE `boolean`	Flag `Y`/`N` — whether the group is visible in the group list
OPENED `boolean`	Flag `Y`/`N` — whether the group is open
DATE_CREATE `string`	Date of group creation in the format `DD.MM.YYYY hh:mm:ss`. If the `DATE_CREATE` key is requested in `select`, the date is returned in a more readable format, for example: `today, 12:16` `yesterday, 14:42` `April 15, 14:42`, if the group was created this year `June 11, 2024 15:08`, if the group was created in a different year
DATE_UPDATE `string`	Date of group update in the format `DD.MM.YYYY hh:mm:ss`
DATE_ACTIVITY `string`	Date of last activity in the group in the format `DD.MM.YYYY hh:mm:ss`
IMAGE_ID `integer`	Identifier of the group's user avatar in the `b_file` table. `0` if a system image is used as the avatar
AVATAR_TYPE `string`	Type of the last set system avatar: `folder` — folder avatar `checks` — checkbox avatar `pie` — pie chart avatar `bag` — briefcase avatar `members` — silhouettes avatar `""` — other system avatar
OWNER_ID `user`	Identifier of the group owner
INITIATE_PERMS `enum`	Who has the right to invite users to the group: `A` — only the group owner `E` — the group owner and group moderators `K` — all group members
NUMBER_OF_MEMBERS `integer`	Number of group members
NUMBER_OF_MODERATORS `integer`	Number of group moderators
PROJECT `boolean`	Flag `Y`/`N` — whether the group is a project
PROJECT_DATE_START `any`	Project start date in the format `DD.MM.YYYY hh:mm:ss`. `null` if not specified
PROJECT_DATE_FINISH `any`	Project end date in the format `DD.MM.YYYY hh:mm:ss`. `null` if not specified
SEARCH_INDEX `string`	Index, keywords for searching the group
LANDING `boolean`	Flag `Y`/`N` — whether the group is a publication group
SCRUM_MASTER_ID `integer`	Identifier of the scrum master. `0` if the group is not a scrum
SCRUM_SPRINT_DURATION `integer`	Duration of the scrum sprint in seconds. `0` if the group is not a scrum
SCRUM_TASK_RESPONSIBLE `string`	Default executor when assigning tasks: `A` — Creator `M` — Scrum master `""` — the group is not a scrum
TYPE `enum`	Type of group: `group` — group `project` — project `scrum` — scrum `collab` — collaboration
MEMBERS `array`	Identifiers of group members
CHAT_ID `integer`	Identifier of the group chat
DIALOG_ID `string`	Identifier of the group dialog
ORDINARY_MEMBERS `array`	Array of user identifiers in the group who are not owners or moderators
INVITED_MEMBERS `array`	Array of portal user identifiers who have been invited to the group but have not yet accepted
MODERATOR_MEMBERS `array`	Array of group member identifiers with the role of moderator
SITE_IDS `array`	List of site identifiers to which the group belongs
AVATAR `string`	URL of the group's compressed user avatar. `""` if no user avatar is set
AVATAR_TYPES `object`	Object containing group avatars (detailed description)
AVATAR_DATA `object`	Information about the group's avatar (detailed description)
OWNER_DATA `object`	Information about the group owner (detailed description)
SUBJECT_DATA `object`	Information about the group's subject specified in the advanced group settings (detailed description)
TAGS `array`	Group tags, similar to `KEYWORDS`, but in array format
ACTIONS `object`	Data about operations available to the current user on the group (detailed description)
USER_DATA `object`	Information about the current user regarding the group (detailed description)
DEPARTMENTS `array`	Array of identifiers of departments added to the group
IS_PIN `boolean`	Value `true`/`false` — whether the group is pinned for the current user on the groups and projects page
PRIVACY_CODE `string`	Group privacy level: `open` — open group `closed` — closed group `secret` — secret group
LIST_OF_MEMBERS `object`	Array with information about group users (detailed description)
FEATURES `object`	Array with information about group tools (detailed description)
LIST_OF_MEMBERS_AWAITING_INVITE `object`	Information about users awaiting confirmation to join the group (detailed description)
GROUP_MEMBERS_LIST `object`	Information about users associated with the group (detailed description)
COUNTERS `object`	Counters (detailed description)
EFFICIENCY `integer`	Group efficiency
ADDITIONAL_DATA `object`	Additional data for the current user (detailed description)

Object AVATAR_TYPES

Name `type`	Description
sort `integer`	Avatar sorting
mobileUrl `string`	URL for displaying the avatar in the mobile application
webCssClass `string`	CSS class of the avatar
entitySelectorUrl `string`	URL of the avatar for entity selector

Object AVATAR_DATA

Name
type

Description

type
string

Type of avatar:

icon — system avatar
image — user image

id
string

Identifier of the avatar:

folder — folder avatar
tasks — checkbox avatar
chart — pie chart avatar
briefcase — briefcase avatar
group — silhouettes avatar
"" — other system avatar
URL — link to the compressed user avatar if set

Object OWNER_DATA

Name `type`	Description
ID `user`	Identifier of the group owner
PHOTO `string`	URL of the compressed avatar of the group owner
FORMATTED_NAME `string`	Formatted name of the group owner according to portal settings

Object SUBJECT_DATA

Name `type`	Description
ID `integer`	Identifier of the subject
NAME `string`	Name of the subject

Object ACTIONS

Name `type`	Description
EDIT `boolean`	Value `true`/`false` — whether editing the group is available
DELETE `boolean`	Value `true`/`false` — whether deleting the group is available
INVITE `boolean`	Value `true`/`false` — whether inviting external participants to the group is available
JOIN `boolean`	Value `true`/`false` — whether the user can join the group
LEAVE `boolean`	Value `true`/`false` — whether the user can leave the group
FOLLOW `boolean`	Value `true`/`false` — whether the user can subscribe to group updates
PIN `boolean`	Value `true`/`false` — whether pinning the group is available
EDIT_FEATURES `boolean`	Value `true`/`false` — whether changing group tools is available

Object USER_DATA

Name `type`	Description
ROLE `any`	User's role in the group: `A` — group owner `E` — group moderator `K` — group member `Z` — awaiting membership `false` — value does not exist
INITIATED_BY_TYPE `any`	Who initiated the user's connection to the group: `U` — user, e.g., the user sent a request to join the group `G` — group, e.g., the user was invited by the group `false` — value does not exist
IS_SUBSCRIBED `boolean`	Value `true`/`false` — whether the user is subscribed to group updates

Object LIST_OF_MEMBERS

Name `type`	Description
id `user`	User identifier
isOwner `boolean`	Value `true`/`false` — whether the user is the group owner
isModerator `boolean`	Value `true`/`false` — whether the user is a moderator
isScrumMaster `boolean`	Value `true`/`false` — whether the user is a scrum master (for scrum groups)
isAutoMember `boolean`	Value `true`/`false` — whether the user was added to the group automatically (without invitation)
name `string`	User's first name
lastName `string`	User's last name
position `string`	User's position
photo `string`	URL of the user's compressed avatar

Object FEATURES

Name `type`	Description
featureName `string`	Symbolic identifier of the tool
name `string`	Name of the tool
customName `string`	Custom name of the tool in the advanced group settings
id `string`	Numeric identifier of the tool
active `boolean`	Value `true`/`false` — whether the tool is enabled in the group

Object LIST_OF_MEMBERS_AWAITING_INVITE

Name `type`	Description
id `user`	User identifier
name `string`	Formatted name according to portal settings
photo `string`	URL of the user's compressed avatar

Object GROUP_MEMBERS_LIST

Name `type`	Description
id `user`	Member identifier
invited `boolean`	Value `true`/`false` — whether the user was invited
isAwaiting `boolean`	Value `true`/`false` — whether the user is awaiting acceptance into the group
isMember `boolean`	Value `true`/`false` — whether the user is a member of the group

Object COUNTERS

Name `type`	Description
workgroup_requests_out `integer`	Current number of unaccepted invitations to the group
workgroup_requests_in `integer`	Current number of requests to join the group

Object ADDITIONAL_DATA

Name
type

Description

ROLE
string

Current user's role in the group:

A — group owner
E — group moderator
K — group member
Z — awaiting membership
"" — user has no relation to the group

INITIATED_BY_TYPE
string

Who initiated the user's connection to the group:

U — user, e.g., the user sent a request to join the group
G — group, e.g., the user was invited by the group
"" — user has no relation to the group

Error Handling

HTTP Code: 400

{
            "error": "SONET_CONTROLLER_WORKGROUP_EMPTY",
            "error_description": "No value for the workgroup ID was provided."
        }

Name `type`	Description
error `string`	String error code. It may consist of digits, Latin letters, and underscores
error_description `error_description`	Textual description of the error. The description is not intended to be shown to the end user in its raw form

Possible Error Codes

Code	Description	Value
`SONET_CONTROLLER_WORKGROUP_EMPTY`	`No value for the workgroup ID was provided.`	The `groupId` parameter was not passed in the `params` array
`SONET_CONTROLLER_WORKGROUP_NOT_FOUND`	`Workgroup not found.`	The group with identifier `params[groupId]` was not found or the current user does not have access to it

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 permitted for calls 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 HTTPS protocol is required for method calls
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is only available on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user associated with the access token or webhook used to call the method lacks the necessary 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 portal administrator has restricted access to this application to specific users only
`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 "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

Modify Group or Project

Get List of Workgroups

Retrieve Data on Workgroup socialnetwork.api.workgroup.get

Method ParametersMethod Parameters

Parameter paramsParameter params

Parameter selectParameter select

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Key resultKey result

Object AVATAR_TYPESObject AVATAR_TYPES

Object AVATAR_DATAObject AVATAR_DATA

Object OWNER_DATAObject OWNER_DATA

Object SUBJECT_DATAObject SUBJECT_DATA

Object ACTIONSObject ACTIONS

Object USER_DATAObject USER_DATA

Object LIST_OF_MEMBERSObject LIST_OF_MEMBERS

Object FEATURESObject FEATURES

Object LIST_OF_MEMBERS_AWAITING_INVITEObject LIST_OF_MEMBERS_AWAITING_INVITE

Object GROUP_MEMBERS_LISTObject GROUP_MEMBERS_LIST

Object COUNTERSObject COUNTERS

Object ADDITIONAL_DATAObject ADDITIONAL_DATA

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning