Usergroups

Usergroups List

GET
/usergroups.list

List all User Groups for a team

Authorization

slackAuth usergroups:read
AuthorizationBearer <token>

In: header

Scope: usergroups:read

Query Parameters

include_users?boolean

Include the list of users for each User Group.

token*string

Authentication token. Requires scope: usergroups:read

include_count?boolean

Include the number of users in each User Group.

include_disabled?boolean

Include disabled User Groups.

Header Parameters

Content-Type*"application/x-www-form-urlencoded"

Value in

  • "application/x-www-form-urlencoded"

Response Body

application/json

application/json

curl -X GET "https://example.com/usergroups.list?token=string" \  -H "Content-Type: application/x-www-form-urlencoded"
{  "ok": "True",  "usergroups": [    {      "auto_provision": true,      "auto_type": null,      "channel_count": 0,      "created_by": "string",      "date_create": 0,      "date_delete": 0,      "date_update": 0,      "deleted_by": null,      "description": "string",      "enterprise_subteam_id": "string",      "handle": "string",      "id": "string",      "is_external": true,      "is_subteam": true,      "is_usergroup": true,      "name": "string",      "prefs": {        "channels": [          "string"        ],        "groups": [          "string"        ]      },      "team_id": "string",      "updated_by": "string",      "user_count": 0,      "users": [        "string"      ]    }  ]}