Current section
Files
Jump to
Current section
Files
priv/docs/methods/team.externalTeams.list.json
{
"args": {
"connection_status_filter": {
"desc": "Status of the connected team. _Acceptable values:_ `CONNECTED` `DISCONNECTED` `BLOCKED` `IN_REVIEW`",
"required": false,
"type": "string"
},
"cursor": {
"desc": "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",
"required": false,
"type": "string"
},
"limit": {
"default": "20",
"desc": "The maximum number of items to return per page",
"required": false,
"type": "integer"
},
"slack_connect_pref_filter": {
"desc": "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`",
"required": false,
"type": "array"
},
"sort_direction": {
"default": "asc",
"desc": "Direction to sort in asc or desc",
"required": false,
"type": "string"
},
"sort_field": {
"default": "team_name",
"desc": "Name of the parameter that we are sorting by",
"required": false,
"type": "string"
},
"workspace_filter": {
"desc": "Shows connected orgs which are connected on a specified encoded workspace ID",
"required": false,
"type": "array"
}
},
"desc": "Returns a list of all the external teams connected and details about the connection.",
"errors": {
"invalid_workspace_filter": "The specified workspace is not valid.",
"not_allowed": "The user is not allowed to perform the action.",
"restricted_action": "The user does not have permission to perform the action.",
"user_cannot_manage_workspace": "The calling user cannot manage the workspace passed in the workspace filter."
},
"rate_limit": {
"label": "Tier 2: 20+ per minute",
"url": "https://docs.slack.dev/apis/web-api/rate-limits"
},
"scopes": {
"bot": [
{
"name": "conversations.connect:manage",
"url": "https://docs.slack.dev/reference/scopes/conversations.connect.manage"
},
{
"name": "team:read",
"url": "https://docs.slack.dev/reference/scopes/team.read"
}
]
}
}