usergroups list
GET {{baseUrl}}/usergroups.list?include_users=<boolean>&include_count=<boolean>&include_disabled=<boolean>
List all User Groups for a team
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
include_users | string | Include the list of users for each User Group. | |
include_count | string | Include the number of users in each User Group. | |
include_disabled | string | Include disabled User Groups. |
RESPONSES
status: OK
{"ok":"\u003cboolean\u003e","usergroups":[{"id":"\u003cstring\u003e","team_id":"\u003cstring\u003e","is_usergroup":"\u003cboolean\u003e","is_subteam":"\u003cboolean\u003e","name":"\u003cstring\u003e","description":"\u003cstring\u003e","handle":"\u003cstring\u003e","is_external":"\u003cboolean\u003e","date_create":"\u003cinteger\u003e","date_update":"\u003cinteger\u003e","date_delete":"\u003cinteger\u003e","auto_type":{},"auto_provision":"\u003cboolean\u003e","enterprise_subteam_id":"\u003cstring\u003e","created_by":"\u003cstring\u003e","updated_by":"\u003cstring\u003e","deleted_by":{},"prefs":{"channels":["\u003cstring\u003e","\u003cstring\u003e"],"groups":["\u003cstring\u003e","\u003cstring\u003e"]},"channel_count":"\u003cinteger\u003e","user_count":"\u003cinteger\u003e","users":["\u003cstring\u003e","\u003cstring\u003e"]},{"id":"\u003cstring\u003e","team_id":"\u003cstring\u003e","is_usergroup":"\u003cboolean\u003e","is_subteam":"\u003cboolean\u003e","name":"\u003cstring\u003e","description":"\u003cstring\u003e","handle":"\u003cstring\u003e","is_external":"\u003cboolean\u003e","date_create":"\u003cinteger\u003e","date_update":"\u003cinteger\u003e","date_delete":"\u003cinteger\u003e","auto_type":{},"auto_provision":"\u003cboolean\u003e","enterprise_subteam_id":"\u003cstring\u003e","created_by":"\u003cstring\u003e","updated_by":"\u003cstring\u003e","deleted_by":{},"prefs":{"channels":["\u003cstring\u003e","\u003cstring\u003e"],"groups":["\u003cstring\u003e","\u003cstring\u003e"]},"channel_count":"\u003cinteger\u003e","user_count":"\u003cinteger\u003e","users":["\u003cstring\u003e","\u003cstring\u003e"]}]}