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 collapse

Instance Method Details

#auth_teams_list(options = {}) ⇒ Object

Obtain a full list of workspaces your org-wide app has been approved for.

Parameters:

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

    a customizable set of options

Options Hash (options):

  • :cursor (string) —

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

  • :include_icon (boolean) —

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

  • :limit (integer) —

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

See Also:



20
21
22
23
24
25
26
27
28
 
# 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