socialnetwork.api.workgroup.list
Method returns list of groups.
Parameters
Parameter | Description | Available from version |
---|---|---|
filter | Corresponds to parameter arFilter for the method API CSocNetGroup::getList. | |
select | Array, specifying selected fields. Contains list of fields to be returned by the method. If an array is empty, selects the following fields: ID, SITE_ID, NAME, DESCRIPTION, DATE_CREATE, DATE_UPDATE, DATE_ACTIVITY, ACTIVE, VISIBLE, OPENED, CLOSED, SUBJECT_ID, OWNER_ID, KEYWORDS, IMAGE_ID, NUMBER_OF_MEMBERS, INITIATE_PERMS, SPAM_PERMS, SUBJECT_NAME. Array can have any permissible fields from list of fields. | |
IS_ADMIN | Passing as Y checks if current user is a social network admin. If yes, disables permission check when retrieving groups. |
Example
BX.rest.callMethod('socialnetwork.api.workgroup.list', { filter: { ID: 424 }, select: [ 'ID', 'NAME' ] });
© «Bitrix24», 2001-2024