SlackWebAPI v1.2.0 SlackWebAPI.Api.Team View Source

API calls for all endpoints tagged Team.

Link to this section Summary

Functions

Gets the access logs for the current team.

Gets billable users information for the current team.

Gets information about the current team.

Gets the integration logs for the current team.

Retrieve a team's profile.

Link to this section Functions

Link to this function

team_access_logs(connection, opts \\ [])

View Source
team_access_logs(Tesla.Env.client(), keyword()) ::
  {:ok, map()} | {:error, Tesla.Env.t()}

Gets the access logs for the current team.

Parameters

  • connection (SlackWebAPI.Connection): Connection to server
  • opts (KeywordList): [optional] Optional parameters

    • :count (String.t):
    • :token (String.t): Authentication token. Requires scope: admin
    • :page (String.t):
    • :before (integer()): End of time range of logs to include in results (inclusive).

Returns

{:ok, %{}} on success {:error, info} on failure

Link to this function

team_billable_info(connection, opts \\ [])

View Source
team_billable_info(Tesla.Env.client(), keyword()) ::
  {:ok, map()} | {:error, Tesla.Env.t()}

Gets billable users information for the current team.

Parameters

  • connection (SlackWebAPI.Connection): Connection to server
  • opts (KeywordList): [optional] Optional parameters

Returns

{:ok, %{}} on success {:error, info} on failure

Link to this function

team_info(connection, opts \\ [])

View Source
team_info(Tesla.Env.client(), keyword()) ::
  {:ok, map()} | {:error, Tesla.Env.t()}

Gets information about the current team.

Parameters

  • connection (SlackWebAPI.Connection): Connection to server
  • opts (KeywordList): [optional] Optional parameters

    • :token (String.t): Authentication token. Requires scope: team:read
    • :team (String.t): Team to get info on, if omitted, will return information about the current team. Will only return team that the authenticated token is allowed to see through external shared channels

Returns

{:ok, %{}} on success {:error, info} on failure

Link to this function

team_integration_logs(connection, opts \\ [])

View Source
team_integration_logs(Tesla.Env.client(), keyword()) ::
  {:ok, map()} | {:error, Tesla.Env.t()}

Gets the integration logs for the current team.

Parameters

  • connection (SlackWebAPI.Connection): Connection to server
  • opts (KeywordList): [optional] Optional parameters

    • :count (String.t):
    • :change_type (String.t): Filter logs with this change type. Defaults to all logs.
    • :app_id (integer()): Filter logs to this Slack app. Defaults to all logs.
    • :token (String.t): Authentication token. Requires scope: admin
    • :user (String.t): Filter logs generated by this user’s actions. Defaults to all logs.
    • :service_id (integer()): Filter logs to this service. Defaults to all logs.
    • :page (String.t):

Returns

{:ok, %{}} on success {:error, info} on failure

Link to this function

team_profile_get(connection, opts \\ [])

View Source
team_profile_get(Tesla.Env.client(), keyword()) ::
  {:ok, map()} | {:error, Tesla.Env.t()}

Retrieve a team's profile.

Parameters

  • connection (SlackWebAPI.Connection): Connection to server
  • opts (KeywordList): [optional] Optional parameters

    • :token (String.t): Authentication token. Requires scope: users.profile:read
    • :visibility (String.t): Filter by visibility.

Returns

{:ok, %{}} on success {:error, info} on failure