Usergroup object

A usergroup object contains information about a group of users.

{
    "id": "S123ABC456",
    "team_id": "T060RNRCH",
    "is_usergroup": true,
    "name": "Workspace Admins",
    "description": "A group of all Administrators on your workspace.",
    "handle": "admins",
    "is_external": false,
    "date_create": 1446598059,
    "date_update": 1446670362,
    "date_delete": 0,
    "auto_type": "admin",
    "created_by": "USLACKBOT",
    "updated_by": "U060RNRCZ",
    "deleted_by": null,
    "prefs": {
        "channels": [],
        "groups": []
    },
    "users": [
        "U060RNRCZ",
        "U060ULRC0",
        "U06129G2V",
        "U061309JM"
    ],
    "user_count": "4"
}

Usergroup object fields

Field	Type	Description
`auto_provision`	Boolean	Whether members are auto-provisioned into this group. Required field.
`auto_type`	String or null	Can be `admins` for a Workspace Admins group, `owner` for a Workspace Owners group or `null` for a custom group.
`channel_count`	Integer	Number of channels associated with this usergroup.
`channels`	Array of `channel_id`	Channel IDs associated with this usergroup.
`created_by`	String or null	User ID of the member who created the user group.
`date_create`	Unix timestamp	When the user group was created.
`date_delete`	Unix timestamp	Non-zero value for disabled groups.
`date_update`	Unix timestamp	When the user group was last updated.
`deleted_by`	String or null	User ID of the member who deleted the user group.
`description`	String	Explains the purpose of the group (optional).
`enterprise_id`	String (`enterprise_id`)	Enterprise organization ID this usergroup belongs to.
`enterprise_subteam_id`	String	Enterprise-level subteam ID. Required field.
`handle`	String	Indicates the value used to notify group members via a mention without a leading @ sign.
`id`	String	The ID of the usergroup.
`is_editing_restricted`	Boolean	Whether editing the usergroup is restricted.
`is_external`	Boolean	Indicates if the user group is external.
`is_idp_group`	Boolean	Whether this usergroup is synced from an identity provider (SCIM/SSO).
`is_membership_locked`	Boolean	Whether membership changes are locked.
`is_org_level`	Boolean	Whether this is an org-level (enterprise-wide) usergroup.
`is_section`	Boolean	Whether this usergroup represents a sidebar section.
`is_subteam`	Boolean	Whether this is a subteam. Required field.
`is_usergroup`	Boolean	Indicates if the object is a user group.
`is_visible`	Boolean	Whether the usergroup is visible to members.
`name`	String	Indicates the friendly name of the group.
`prefs`	Object	Contains default `channels` and `groups` (private channels) that members of this group will be invited to upon joining, in addition to `file_id` (string) and `additional_channels` (array of `channel_id`).
`team_id`	String	The ID of the team.
`teams`	Array of `workspace_id`	Workspace IDs this usergroup spans (for org-level groups).
`updated_by`	String or null	User ID of the member who updated the user group.
`user_count`	Integer	Indicates the total number of users in a group.
`users`	Array	Contains a list of user object `id` values which belong to the user group. This parameter is included if the `include_users` option is enabled on some API endpoints.

Usergroup object fields​

Usergroup object fields