Skip to main content

team.externalTeams.list method

Facts​

DescriptionReturns a list of all the external teams connected and details about the connection.
Method Access
GET https://slack.com/api/team.externalTeams.list
Scopes
Content types
application/x-www-form-urlencoded
application/json
Rate LimitsTier 2: 20+ 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

limitintegerOptional

The maximum number of items to return per page

Default: 20
cursorstringOptional

Paginate through collections of data by setting parameter to the team_id attribute returned by a previous request's response_metadata. If not provided, the first page of the collection is returned. See pagination for more detail.

Example: T123ABC456
sort_fieldstringOptional

Name of the parameter that we are sorting by

Default: team_name
sort_directionstringOptional

Direction to sort in asc or desc

Default: asc
slack_connect_pref_filterarrayOptional

Filters connected orgs by Slack Connect pref override(s). Value can be: approved_orgs_only allow_sc_file_uploads profile_visibility away_team_sc_invite_permissions accept_sc_invites sc_mpdm_to_private require_sc_channel_for_sc_dm external_awareness_context_bar

workspace_filterarrayOptional

Shows connected orgs which are connected on a specified encoded workspace ID

connection_status_filterstringOptional

Status of the connected team.

Usage info​

Use this method to return information about teams connected via Slack Connect.

Response​

Typical success response

{
  "ok": true,
  "organizations": [
    {
      "team_id": "T123ABC456",
      "team_name": "Sandra Inc.",
      "team_domain": "sandra",
      "public_channel_count": 1,
      "private_channel_count": 1,
      "im_channel_count": 1,
      "mpim_channel_count": 1,
      "connected_workspaces": {
        "workspace_id": "Jesse Inc",
        "workspace_name": "E123ABC456"
      },
      "slack_connect_prefs": {},
      "connection_status": "CONNECTED",
      "last_active_timestamp": 1718656058,
      "is_sponsored": false,
      "canvas": {
        "total_count": 1,
        "ownership_details": [
          {
            "team_id": "T123ABC456"
          },
          {
            "count": 1
          }
        ]
      },
      "lists": {
        "total_count": 1,
        "ownership_details": [
          {
            "team_id": "T123ABC456"
          },
          {
            "count": 1
          }
        ]
      }
    }
  ],
  "total_count": 1,
  "response_metadata": {
    "next_cursor": "T123ABC999"
  }
}

Typical error response

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

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.

internal_error

There was an internal error processing this request.

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

One or more of the API arguments are 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

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_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.

invalid_workspace_filter

The specified workspace is not valid.

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

The user is not allowed to perform the action.

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.

restricted_action

The user does not have permission to perform the action.

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.

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.

user_cannot_manage_workspace

The calling user cannot manage the workspace passed in the workspace filter.