Module: Slack::Web::Api::Endpoints::AuthTeams

Included in:

Slack::Web::Api::Endpoints

Defined in:

lib/slack/web/api/endpoints/auth_teams.rb

Instance Method Summary

• #auth_teams_list(options = {}) ⇒ Object

  List the workspaces a token can access.

Instance Method Details

#auth_teams_list(options = {}) ⇒ Object

List the workspaces a token can access.

Parameters:

• options (Hash) (defaults to: {}) —

  a customizable set of options

Options Hash (options):

• :cursor (Object) —

  Set cursor to next_cursor returned by the previous call to list items in the next page.

• :include_icon (Object) —

  Whether to return icon paths for each workspace. An icon path represents a URI pointing to the image signifying the workspace.

• :limit (Object) —

  The maximum number of workspaces to return. Must be a positive integer no larger than 1000.

See Also:

• https://api.slack.com/methods/auth.teams.list
• https://github.com/slack-ruby/slack-api-ref/blob/master/methods/auth.teams/auth.teams.list.json

# File 'lib/slack/web/api/endpoints/auth_teams.rb', line 20

def auth_teams_list(options = {})
  if block_given?
    Pagination::Cursor.new(self, :auth_teams_list, options).each do |page|
      yield page
    end
  else
    post('auth.teams.list', options)
  end
end