/admin.users.list

GET

/admin.users.list

List users on a workspace

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://slack.com/api/admin.users.list?team_id=' \
--header 'token;'

Response Example

200 - response

{
    "ok": true,
    "users": [
        {
            "email": "bront@slack.com",
            "id": "T1234",
            "is_admin": false,
            "is_bot": false,
            "is_owner": false,
            "is_primary_owner": false,
            "is_restricted": false,
            "is_ultra_restricted": false
        }
    ]
}

Request

Query Params

team_id

string

required

The ID (T1234) of the workspace.

cursor

string

optional

Set cursor to next_cursor returned by the previous call to list items in the next page.

limit

integer

optional

Limit for how many users to be retrieved per page

Header Params

token

string

required

Authentication token. Requires scope: admin.users:read

Responses

🟢200Typical success response

application/json

Body

This method either only returns a brief _OK_ response or a verbose schema is not available for this method.

enum<boolean>

required

Allowed value:

true

Additional properties

integer | number | string | boolean

optional

🔴500Typical error response

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

/admin.users.invite

/admin.users.remove