/users.list

GET

/users.list

users

Lists all users in a Slack team.

Response Example

200 - response

{
    "cache_ts": 1498777272,
    "members": [
        {
            "color": "9f69e7",
            "deleted": false,
            "has_2fa": false,
            "id": "W012A3CDE",
            "is_admin": true,
            "is_app_user": false,
            "is_bot": false,
            "is_owner": false,
            "is_primary_owner": false,
            "is_restricted": false,
            "is_ultra_restricted": false,
            "name": "spengler",
            "profile": {
                "avatar_hash": "ge3b51ca72de",
                "display_name": "spengler",
                "display_name_normalized": "spengler",
                "email": "spengler@ghostbusters.example.com",
                "image_192": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg",
                "image_24": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg",
                "image_32": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg",
                "image_48": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg",
                "image_512": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg",
                "image_72": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg",
                "real_name": "Egon Spengler",
                "real_name_normalized": "Egon Spengler",
                "status_emoji": ":books:",
                "status_text": "Print is dead",
                "team": "T012AB3C4"
            },
            "real_name": "spengler",
            "team_id": "T012AB3C4",
            "tz": "America/Los_Angeles",
            "tz_label": "Pacific Daylight Time",
            "tz_offset": -25200,
            "updated": 1502138686
        },
        {
            "color": "9f69e7",
            "deleted": false,
            "has_2fa": false,
            "id": "W07QCRPA4",
            "is_admin": true,
            "is_bot": false,
            "is_owner": false,
            "is_primary_owner": false,
            "is_restricted": false,
            "is_ultra_restricted": false,
            "name": "glinda",
            "profile": {
                "avatar_hash": "8fbdd10b41c6",
                "display_name": "Glinda the Fairly Good",
                "display_name_normalized": "Glinda the Fairly Good",
                "email": "glenda@south.oz.coven",
                "first_name": "Glinda",
                "image_1024": "https://a.slack-edge.com...png",
                "image_192": "https://a.slack-edge.com...png",
                "image_24": "https://a.slack-edge.com...png",
                "image_32": "https://a.slack-edge.com...png",
                "image_48": "https://a.slack-edge.com...png",
                "image_512": "https://a.slack-edge.com...png",
                "image_72": "https://a.slack-edge.com...png",
                "image_original": "https://a.slack-edge.com...png",
                "last_name": "Southgood",
                "phone": "",
                "real_name": "Glinda Southgood",
                "real_name_normalized": "Glinda Southgood",
                "skype": "",
                "title": "Glinda the Good"
            },
            "real_name": "Glinda Southgood",
            "team_id": "T0G9PQBBK",
            "tz": "America/Los_Angeles",
            "tz_label": "Pacific Daylight Time",
            "tz_offset": -25200,
            "updated": 1480527098
        }
    ],
    "ok": true,
    "response_metadata": {
        "next_cursor": "dXNlcjpVMEc5V0ZYTlo="
    }
}

Request

Query Params

token

string

optional

Authentication token. Requires scope: users:read

limit

integer

optional

The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached. Providing no limit value will result in Slack attempting to deliver you the entire result set. If the collection is too large you may experience limit_required or HTTP 500 errors.

cursor

string

optional

Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request's response_metadata. Default value fetches the first "page" of the collection. See pagination for more detail.

include_locale

string

optional

Set this to true to receive the locale for users. Defaults to false

Responses

🟢200Typical success response

application/json

Body

Schema for successful response from users.list method

cache_ts

integer

required

members

array[array (objs_user) {1}]

required

>= 1 items

optional

enum<boolean>

required

Allowed value:

true

response_metadata

array [anyOf]

optional

object

new paging style

optional

object

deprecation_warning

optional

object

deprecation_warning and paging style together

optional

🔴500Typical error response

/users.info

/users.lookupByEmail