admin.users.list method

The features within are only available to Slack workspaces on an Enterprise plan.

Don't have a paid plan? Join the Developer Program and provision a fully-featured sandbox for free.

Facts

DescriptionList users on a workspace

Method Access

HTTP

POST https://slack.com/api/admin.users.list

JavaScript

app.client.admin.users.list

Python

app.client.admin_users_list

Java

app.client().adminUsersList

Scopes

User token:

admin.users:read

Content types

application/x-www-form-urlencoded

application/json

Rate LimitsTier 4: 100+ per minute

Arguments

Required arguments

tokenstringRequired

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

Example: xxxx-xxxxxxxxx-xxxx

Optional arguments

team_idOptional

The ID (T1234) of a workspace. Filters results to just the specified workspace.

cursorstringOptional

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

Example: 5c3e53d5

is_activebooleanOptional

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

include_deactivated_user_workspacesbooleanOptional

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.

only_guestsbooleanOptional

If true, returns only guests and their expiration dates that belong to the team_id

limitintegerOptional

Limit for how many users to be retrieved per page

Default: 100

Example: 50

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 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. The Org Admin or Owner installing the app must have the Channel Management role, and must also be granted access to Public channels and Private channels within this role. If these criteria aren't met, the Org Admin or Owner will receive a not_allowed error when attempting to install an app.

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

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

To configure and install an app supporting Admin API endpoints on your Enterprise 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 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 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 Enterprise organization, not a workspace within the organization.

Admin Roles

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

Role	Role ID	Scope Type
Analytics Admin	Rl0L	Team or Org
Audit Logs Admin	Rl0C	Team or Org
Channel Admin	Rl01	Team or Org
Channel Manager	Rl0A	Team or Org
Conversation Admin	Rl05	Team or Org
DLP Admin	Rl09	Org
Exports Admin	Rl0F	Org
Integrations Manager	Rl0D	Org
Legal Holds Admin	Rl04	Org
Message Activity Manager	Rl0E	Org
Role Admin	Rl02	Team or Org
Sales Admin	Rl0G	Org
Security Admin	Rl0J	Org
Slack Platform Developer	Rl0B	Team or Org
User Admin	Rl03	Team or Org
Workflow Admin	Rl0K	Org

---

Response

Typical success response

{
  "ok": true,
  "users": [
    {
      "id": "W0L3P31SP",
      "email": "john.doe@slack.com",
      "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": [
        "T123"
      ],
      "has_2fa": false,
      "has_sso": false
    }
  ]
}

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

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 parameter in the response.

Error

Description

access_denied

Access to a resource specified in the request is denied.

accesslimited

Access to this method is limited on the current network

account_inactive

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

deprecated_endpoint

The endpoint has been deprecated.

ekm_access_denied

Administrators have suspended the ability to post a message.

enterprise_is_restricted

The method cannot be called from an Enterprise.

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.

feature_not_enabled

The Admin APIs feature is not enabled for this team.

include_deactivated_user_workspaces_invalid

include_deactivated_user_workspaces only applies with org token and no team_id.

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.

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_arguments

The passed arguments were invalid.

invalid_arguments

The method was called with invalid arguments.

invalid_array_arg

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

invalid_auth

This request could not be authorized.

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.

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_cursor

The passed cursor could not be validated.

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.

method_deprecated

The method has been deprecated.

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.

missing_scope

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

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.

not_allowed_token_type

The token type used in this request is not allowed.

not_authed

No authentication token provided.

org_login_required

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

ratelimited

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

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

team_access_not_granted

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

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.

team_not_found

team_id was not found.

token_expired

Authentication token has expired

token_revoked

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

two_factor_setup_required

Two factor setup is required.