Documentation

socialnetwork.api.workgroup.get

Method returns workgroup data.

Parameters

Parameter Description Available from version
groupId Group ID. Required parameter, integer.

Fields

Available fields:

Field Description Available from version
ID Group ID
ACTIVE Flag Y/N - if group is active.
SUBJECT_ID Subject ID code (required).
SUBJECT_DATA Group subject fields.
NAME Group name
DESCRIPTION Group description
KEYWORDS Keywords
CLOSED Flag Y/N - if group is archived,
VISIBLE Flag Y/N - if group is listed in group list,
OPENED Flag Y/N - if the group is opened for joining,
PROJECT Flag Y/N - if the group is a project or not. Default value: no (Available from version 18.0.0).
LANDING Flag Y/N - if the group can be published.
DATE_CREATE Date created
DATE_UPDATE Date updated
DATE_ACTIVITY Date of activity
IMAGE_ID Group avatar file ID
AVATAR Avatar URL
AVATAR_TYPES Data on set of existing avatar types.
AVATAR_TYPE Group avatar type (used, if IMAGE_ID value is not specified). Available values: folder, checks, pie, bag, members.
OWNER_ID Group owner identifier
OWNER_DATA Group owner fields.
NUMBER_OF_MEMBERS Number of group members
NUMBER_OF_MODERATORS Number of group moderators.
INITIATE_PERMS Users who have access permission to invite to group (required field):
  • A - only group owner,
  • E - group owner and group moderator,
  • K - all group members.
PROJECT_DATE_START Project start date
PROJECT_DATE_FINISH Project end date
SCRUM_OWNER_ID SCRUM identifier
SCRUM_MASTER_ID SCRUM master identifier
SCRUM_SPRINT_DURATION Scrum sprint duration in seconds
SCRUM_TASK_RESPONSIBLE Default responsible user in Scrum project. Available values:
  • A - created by
  • M - scrum master
TAGS Group tags
ACTIONS Data for group operations available to the current user.
USER_DATA Data for current user role in group

Example

BX.rest.callMethod('socialnetwork.api.workgroup.get', {
        params: {
           groupId: 424,
           select: [ 'ID', 'NAME' ],
     },
});
© «Bitrix24», 2001-2022
Up