Packages

A Slack Web & Real Time Messaging API client.

Retired package: Renamed - 1.0.0-alpha.0

Current section

Files

Jump to
slack_kit lib slack web docs team.externalTeams.list.json
Raw

lib/slack/web/docs/team.externalTeams.list.json

{
"args": {
"connection_status_filter": {
"desc": "Status of the connected team.\n\n_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": {
"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.",
"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_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."
}
}