Lists all users in a Slack team.

Facts

Method access

HTTP
JavaScript
Python
Java
HTTP
GEThttps://slack.com/api/users.list
Bolt for Java
app.client().usersList
Powered by Bolt
Bolt for Python
app.client.users_list
Powered by Bolt

Content types

application/x-www-form-urlencoded
  • Rate limits

    Tier 2
  • Arguments

    ArgumentTypeDescription
    tokenRequired

    Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.

    Examplexxxx-xxxxxxxxx-xxxx
    cursor
    string

    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.

    ExampledXNlcjpVMDYxTkZUVDI=
    include_locale
    boolean

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

    Exampletrue
    limit
    number

    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.

    Default: 0

    Example20
    team_id
    string

    encoded team id to list users in, required if org token is used

    ExampleT1234567890

    Present arguments as parameters in application/x-www-form-urlencoded querystring or POST body. This method does not currently accept application/json.

    Example responses

    Common successful response

    Typical success response

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

    Typical error response

    {
        "ok": false,
        "error": "invalid_cursor"
    }

    This method returns a list of all users in the workspace. This includes deleted/deactivated users.

    Returns a list of paginated user objects, in no particular order.

    Profile

    The profile hash contains as much information as the user has supplied in the default profile fields: first_name, last_name, real_name, email, skype, and the image_* fields. Data that has not been supplied may not be present at all, may be null or may contain an empty string ("").

    A user's custom profile fields may be discovered using users.profile.get.

    Email addresses

    Accessing email addresses
    The users:read.email OAuth scope is now required to access the email field in user objects returned by the users.list and users.info web API methods. users:read is no longer a sufficient scope for this data field. Learn more.

    Apps created after January 4th, 2017 must request both the users:read and users:read.email OAuth permission scopes when using the OAuth app installation flow to enable access to the email field of user objects returned by this method.

    Pagination

    This method uses cursor-based pagination to make it easier to incrementally collect information. To begin pagination, specify a limit value under 1000. We recommend no more than 200 results at a time.

    Responses will include a top-level response_metadata attribute containing a next_cursor value. By using this value as a cursor parameter in a subsequent request, along with limit, you may navigate through the collection page by virtual page.

    See pagination for more information.

    Presence

    Retrieving a workspace's presence with this method is now deprecated. Use users.getPresence or presence subscriptions instead.

    Errors

    This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing. Callers should always check the value of the ok params in the response.

    ErrorDescription
    invalid_cursor

    Value passed for cursor was not valid or is no longer valid.

    limit_required

    For large teams a limit is required.

    missing_argument

    A required argument is missing.

    team_access_not_granted

    The token used is not granted the specific workspace access required to complete this request.

    not_authed

    No authentication token provided.

    invalid_auth

    Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.

    account_inactive

    Authentication token is for a deleted user or workspace when using a bot token.

    token_revoked

    Authentication token is for a deleted user or workspace or the app has been removed when using a user token.

    token_expired

    Authentication token has expired

    no_permission

    The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.

    org_login_required

    The workspace is undergoing an enterprise migration and will not be available until migration is complete.

    ekm_access_denied

    Administrators have suspended the ability to post a message.

    missing_scope

    The token used is not granted the specific scope permissions required to complete this request.

    not_allowed_token_type

    The token type used in this request is not allowed.

    method_deprecated

    The method has been deprecated.

    deprecated_endpoint

    The endpoint has been deprecated.

    two_factor_setup_required

    Two factor setup is required.

    enterprise_is_restricted

    The method cannot be called from an Enterprise.

    invalid_arguments

    The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.

    invalid_arg_name

    The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.

    invalid_array_arg

    The method was passed an array as an argument. Please only input valid strings.

    invalid_charset

    The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8 iso-8859-1.

    invalid_form_data

    The method was called via a POST request with Content-Type application/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.

    invalid_post_type

    The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/json application/x-www-form-urlencoded multipart/form-data text/plain.

    missing_post_type

    The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.

    team_added_to_org

    The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.

    ratelimited

    The request has been ratelimited. Refer to the Retry-After header for when to retry the request.

    accesslimited

    Access to this method is limited on the current network

    request_timeout

    The method was called via a POST request, but the POST data was either missing or truncated.

    service_unavailable

    The service is temporarily unavailable

    fatal_error

    The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.

    internal_error

    The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.

    Warnings

    This table lists the expected warnings that this method will return. However, other warnings can be returned in the case where the service is experiencing unexpected trouble.

    WarningDescription
    missing_charset

    The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.

    superfluous_charset

    The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous.

    Arguments

    Need a token? Create and install a Slack app to begin.
    This will make a real API request. Beware of using it with live workspaces.

    API response


    Submit your arguments to see the API response
    Calling users.list
    Java
    JavaScript
    Python
    Java
    import com.slack.api.Slack;
    import com.slack.api.methods.SlackApiException;
    import com.slack.api.model.User;
    import org.slf4j.LoggerFactory;
    
    import java.io.IOException;
    import java.util.List;
    import java.util.concurrent.ConcurrentHashMap;
    import java.util.concurrent.ConcurrentMap;
    
    public class UsersList {
    
        // You probably want to use a database to store any user information ;)
        static final ConcurrentMap<String, User> usersStore = new ConcurrentHashMap<>();
    
        /**
         * Fetch users using the users.list method
         */
        static void fetchUsers() {
            // you can get this instance via ctx.client() in a Bolt app
            var client = Slack.getInstance().methods();
            var logger = LoggerFactory.getLogger("my-awesome-slack-app");
            try {
                // Call the users.list method using the built-in WebClient
                var result = client.usersList(r -> r
                    // The token you used to initialize your app
                    .token(System.getenv("SLACK_BOT_TOKEN"))
                );
                saveUsers(result.getMembers());
            } catch (IOException | SlackApiException e) {
                logger.error("error: {}", e.getMessage(), e);
            }
        }
    
        /**
         * Put users into an object
         */
        static void saveUsers(List<User> users) {
            for (User user : users) {
                // Store the entire user object (you may not need all of the info)
                usersStore.put(user.getId(), user);
            }
        }
    
        public static void main(String[] args) throws Exception {
            fetchUsers();
        }
    
    }
    
    JavaScript
    Code to initialize Bolt app
    // Require the Node Slack SDK package (github.com/slackapi/node-slack-sdk) const { WebClient, LogLevel } = require("@slack/web-api"); // WebClient insantiates a client that can call API methods // When using Bolt, you can use either `app.client` or the `client` passed to listeners. const client = new WebClient("xoxb-your-token", { // LogLevel can be imported and used to make debugging simpler logLevel: LogLevel.DEBUG });
    // You probably want to use a database to store any user information ;) let usersStore = {}; try { // Call the users.list method using the WebClient const result = await client.users.list(); saveUsers(result.members); } catch (error) { console.error(error); } // Put users into the JavaScript object function saveUsers(usersArray) { let userId = ''; usersArray.forEach(function(user){ // Key user info on their unique user ID userId = user["id"]; // Store the entire user object (you may not need all of the info) usersStore[userId] = user; }); }
    Python
    Code to initialize Bolt app
    import logging import os # Import WebClient from Python SDK (github.com/slackapi/python-slack-sdk) from slack_sdk import WebClient from slack_sdk.errors import SlackApiError # WebClient insantiates a client that can call API methods # When using Bolt, you can use either `app.client` or the `client` passed to listeners. client = WebClient(token=os.environ.get("SLACK_BOT_TOKEN")) logger = logging.getLogger(__name__)
    # You probably want to use a database to store any user information ;) users_store = {} try: # Call the users.list method using the WebClient # users.list requires the users:read scope result = client.users_list() save_users(result["members"]) except SlackApiError as e: logger.error("Error creating conversation: {}".format(e)) # Put users into the dict def save_users(users_array): for user in users_array: # Key user info on their unique user ID user_id = user["id"] # Store the entire user object (you may not need all of the info) users_store[user_id] = user

    Was this page helpful?