List users on a workspace


This API method can only be used on Enterprise Grid workspaces.


Method access

Bolt for Java
Powered by Bolt
Bolt for Python
Powered by Bolt
Bolt for JavaScript
Powered by Bolt

Content types

  • Rate limits

    Tier 4
  • Arguments

    Required arguments

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

    Optional arguments

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


    Only applies with org token and no team_id. If true, return workspaces for a user even if they may be deactivated on them. If false, return workspaces for a user only when user is active on them. Default is false.


    If true, only active users will be returned. If false, only deactivated users will be returned. Default is true.


    Limit for how many users to be retrieved per page


    The ID (T1234) of the workspace. The team_id is required if you use an org-level token.

    Usage info

    This Admin API lists users in a workspace.

    This admin scope is obtained through version two of the OAuth V2 flow, but there are a few additional requirements. The app requesting this scope must be installed by an Admin or Owner of an Enterprise Grid organization. Also, the app must be installed on the entire org, not on an individual workspace. See below for more details.

    If the app is installed by an Org Admin or Owner, ensure the Channel Management settings provide the appropriate permissions. In order to manage channels after they are created, you must update your token to enable permissions for Org Admins or Owners (not just the Primary Org Owner).

    Admin API endpoints reach across an entire Enterprise Grid organization, not individual workspaces.

    For a token to be imbued with admin scopes, it must be obtained from installing an app on the entire Grid org, not just a workspace within the organization.

    To configure and install an app supporting Admin API endpoints on your Enterprise Grid organization:

    1. Create a new Slack app. Your app will need to be able to handle a standard OAuth 2 flow.
    2. In the app's settings, select OAuth & Permissions from the left navigation. Scroll down to the section titled Scopes and add the admin.* scope you want. Click the green Save Changes button.
    3. In the app's settings, select Manage Distribution from the left navigation. Under the section titled Share Your App with Other Workspaces, make sure all four sections have the green check. Then click the green Activate Public Distribution button.
    4. Under the Share Your App with Your Workspace section, copy the Sharable URL and paste it into a browser to initiate the OAuth handshake that will install the app on your organization. You must be logged in as an Admin or Owner of your Enterprise Grid organization to install the app.
    5. Check the dropdown in the upper right of the installation screen to make sure you are installing the app on the organization, not an individual workspace within the organization. See the image below for a visual.
    6. Once your app completes the OAuth flow, you will be granted an OAuth token that can be used for calling Admin API methods for your organization.

    When installing an app to use an Admin API endpoint, be sure to install it on your Grid organization, not a workspace within the organization.

    For more details on the user array returned by this method, check out the user object documentation.

    Admin Roles

    The following roles and their respective scope types can be assigned by Org Owners and Org Admins on Enterprise plans:

    RoleRole IDScope Type
    Analytics AdminRl0LTeam or Org
    Audit Logs AdminRl0CTeam or Org
    Channel AdminRl01Team or Org
    Channel ManagerRl0ATeam or Org
    Compliance AdminRl04Org
    Conversation AdminRl05Team or Org
    DLP AdminRl09Org
    Exports AdminRl0FOrg
    Integrations ManagerRl0DOrg
    Message Activity ManagerRl04Org
    Role AdminRl02Team or Org
    Sales AdminRl0GOrg
    Sales UserRl0HOrg
    Security AdminRl0JOrg
    Slack Platform DeveloperRl0BTeam or Org
    User AdminRl03Team or Org
    Workflow AdminRl0KOrg

    Example responses

    Common successful response

    Typical success response

        "ok": true,
        "users": [
                "id": "W0L3P31SP",
                "email": "",
                "is_admin": false,
                "is_owner": false,
                "is_primary_owner": false,
                "is_restricted": false,
                "is_ultra_restricted": false,
                "is_bot": false,
                "username": "john_doe",
                "full_name": "John Doe",
                "is_active": true,
                "date_created": 1566922090,
                "deactivated_ts": 1678435283,
                "expiration_ts": 0,
                "workspaces": [
                "has_2fa": false,
                "has_sso": false


    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.


    The Admin APIs feature is not enabled for this team.


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


    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.


    The passed cursor could not be validated.


    team_id was not found.


    include_deactivated_user_workspaces only applies with org token and no team_id.


    Access to a resource specified in the request is denied.


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


    The endpoint has been deprecated.


    Administrators have suspended the ability to post a message.


    The method cannot be called from an Enterprise.


    This method cannot be called by a legacy bot.


    The method has been deprecated.


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


    The token type used in this request is not allowed.


    No authentication token provided.


    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.


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


    Authentication token has expired


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


    Two factor setup is required.


    Access to this method is limited on the current network


    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.


    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.


    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.


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


    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.


    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.


    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.


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


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


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


    The service is temporarily unavailable


    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.


    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.


    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.


    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.


    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