List users on a workspace
This API method can only be used on Enterprise Grid workspaces.
POSThttps://slack.com/api/admin.users.list
application/x-www-form-urlencoded
application/json
token
Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.
xxxx-xxxxxxxxx-xxxx
Set cursor
to next_cursor
returned by the previous call to list items in the next page.
5c3e53d5
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.
true
If true, only active users will be returned. If false, only deactivated users will be returned. Default is true.
true
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:
admin.*
scope you want. Click the green Save Changes
button.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.
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 |
Compliance Admin | Rl04 | Org |
Conversation Admin | Rl05 | Team or Org |
DLP Admin | Rl09 | Org |
Exports Admin | Rl0F | Org |
Integrations Manager | Rl0D | Org |
Message Activity Manager | Rl04 | Org |
Role Admin | Rl02 | Team or Org |
Sales Admin | Rl0G | Org |
Sales User | Rl0H | Org |
Security Admin | Rl0J | Org |
Slack Platform Developer | Rl0B | Team or Org |
User Admin | Rl03 | Team or Org |
Workflow Admin | Rl0K | Org |
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
}
]
}
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.
Error | Description |
---|---|
feature_not_enabled | The Admin APIs feature is not enabled for this team. |
invalid_arguments | 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. |
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_cursor | The passed cursor could not be validated. |
team_not_found |
|
include_deactivated_user_workspaces_invalid |
|
access_denied | Access to a resource specified in the request is denied. |
account_inactive | Authentication token is for a deleted user or workspace when using a |
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. |
is_bot | This method cannot be called by a legacy bot. |
method_deprecated | The method has been deprecated. |
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. |
not_authed | No authentication token provided. |
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. |
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 |
two_factor_setup_required | Two factor setup is required. |
accesslimited | Access to this method is limited on the current network |
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. |
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 |
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 |
invalid_form_data | The method was called via a |
invalid_post_type | The method was called via a |
missing_post_type | The method was called via a |
ratelimited | The request has been ratelimited. Refer to the |
request_timeout | The method was called via a |
service_unavailable | The service is temporarily unavailable |
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. |
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.
Warning | Description |
---|---|
missing_charset | The method was called via a |
superfluous_charset | The method was called via a |