/usergroups.users.list

GET

List all users in a User Group

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://slack.com/api/usergroups.users.list?token=&usergroup='

Response Example

200 - response

{
    "ok": true,
    "users": [
        "U060R4BJ4",
        "W123A4BC5"
    ]
}

Request

Query Params

token

string

required

Authentication token. Requires scope: usergroups:read

include_disabled

string

optional

Allow results that involve disabled User Groups.

usergroup

string

required

The encoded ID of the User Group to update.

🟢200Standard success response when used with a user token

application/json

Body

Schema for successful response from usergroups.users.list method

enum<boolean>

required

Allowed value:

true

users

array[string]

required

🔴500Standard failure response when used with an invalid token

Modified at 2023-08-15 05:39:46