admin.conversations.getTeams
Get all the workspaces a given public or private channel is connected to within this Enterprise org.
Facts
Method URL: | https://slack.com/api/admin.conversations.getTeams | ||||
---|---|---|---|---|---|
Preferred HTTP method: | POST | ||||
Accepted content types: | application/x-www-form-urlencoded , application/json | ||||
Rate limiting: | Tier 2 | ||||
Works with: |
|
This Admin API method gets the workspaces connected to a given channel within the organization.
Note: this method doesn't list workspaces from other Enterprise organizations that are also connected to the same channel.
This API method for admins may only be used on Enterprise Grid.
Arguments
token
Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.
Examplexxxx-xxxxxxxxx-xxxx
channel_id
The channel to determine connected workspaces within the organization for.
ExampleC12345
cursor
Set cursor
to next_cursor
returned by the previous call to list items in the next page
5c3e53d5
limit
The maximum number of items to return. Must be between 1 - 1000 both inclusive.
Default: 100
100
application/json
via HTTP POST. Present your token
in your request's Authorization
header. Learn more.
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.
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:
- Create a new Slack app. Your app will need to be able to handle a standard OAuth 2 flow.
-
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. - 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.
- 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.
- 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.
- 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.
Response
Common successful response
Typical success response
{
"ok": true,
"teams": "T1234,T5678"
}
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.
Error | Description |
---|---|
feature_not_enabled | The token provided doesn't have access to this method. |
channel_not_found | The channel wasn't found or isn't connected to multiple workspaces. |
channel_type_not_supported | The |
unsupported_team_type | This endpoint can only called by Enterprise organizations. |
restricted_action | A workspace preference prevents the authenticated user from listing the workspaces connected to a channel. |
could_not_get_teams | Could not fetch the workspaces that the channel is shared with in this organization. |
invalid_cursor | The provided cursor wasn't valid. |
invalid_limit | The value passed for |
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. |
token_revoked | Authentication token is for a deleted user or workspace or the app has been removed. |
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. |
is_bot | This method cannot be called by a bot user. |
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 |
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 |
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 |
accesslimited | Access to this method is limited on the current network |
request_timeout | The method was called via a |
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.
Warning | Description |
---|---|
missing_charset | The method was called via a |
superfluous_charset | The method was called via a |