Work with Teams

The following are Apex classes for the Slack team API methods.

Represents a team.

The following are methods for Team.

Signature

Return Value

Type: List<String>

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: Slack.TeamIcon

Signature

Return Value

Type: String

Signature

Return Value

Type: Boolean

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Parameters

defaultChannels

Type: List<String>

Return Value

Type: void

Signature

Parameters

discoverable

Type: String

Return Value

Type: void

Signature

Parameters

domain

Type: String

Return Value

Type: void

Signature

Parameters

emailDomain

Type: String

Return Value

Type: void

Signature

Parameters

enterpriseId

Type: String

Return Value

Type: void

Signature

Parameters

enterpriseDomain

Type: String

Return Value

Type: void

Signature

Parameters

enterpriseName

Type: String

Return Value

Type: void

Signature

Parameters

icon

Type: Slack.TeamIcon

Return Value

Type: void

Signature

Parameters

id

Type: String

Return Value

Type: void

Signature

Parameters

isVerified

Type: Boolean

Return Value

Type: void

Signature

Parameters

name

Type: String

Return Value

Type: void

Signature

Parameters

url

Type: String

Return Value

Type: void

The following are methods for Team.Profile.

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: Slack.Team.ProfileOptions

Signature

Return Value

Type: Integer

Signature

Return Value

Type: List<String>

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Parameters

fieldName

Type: String

Return Value

Type: void

Signature

Parameters

hidden

Type: Boolean

Return Value

Type: void

Signature

Parameters

hintValue

Type: String

Return Value

Type: void

Signature

Parameters

id

Type: String

Return Value

Type: void

Signature

Parameters

label

Type: String

Return Value

Type: void

Signature

Parameters

options

Type: Slack.Team.ProfileOptions

Return Value

Type: void

Signature

Parameters

ordering

Type: Integer

Return Value

Type: void

Signature

Parameters

possibleValues

Type: List<String>

Return Value

Type: void

Signature

Parameters

type

Type: String

Return Value

Type: void

The following are methods for Team.ProfileOptions.

Signature

Return Value

Type: Boolean

Signature

Parameters

_protected

Type: Boolean

Return Value

Type: void

Represents the team's icon.

The following are methods for TeamIcon.

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Returns true if a team has not yet set a custom icon.

Signature

Return Value

Type: Boolean

Signature

Parameters

image34

Type: String

Return Value

Type: void

Signature

Parameters

image44

Type: String

Return Value

Type: void

Signature

Parameters

image68

Type: String

Return Value

Type: void

Signature

Parameters

image88

Type: String

Return Value

Type: void

Signature

Parameters

image102

Type: String

Return Value

Type: void

Signature

Parameters

image132

Type: String

Return Value

Type: void

Signature

Parameters

image230

Type: String

Return Value

Type: void

Signature

Parameters

imageDefault

Type: Boolean

Return Value

Type: void

Signature

Parameters

imageOriginal

Type: String

Return Value

Type: void

Represents billable users information.

The following are methods for BillableInfo.

Signature

Return Value

Type: Boolean

Signature

Parameters

billingActive

Type: Boolean

Represents the integration activity logs for a team.

Usage

See Slack's team.integrationLogs method.

The following are methods for IntegrationLogs.

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: Integer

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: Boolean

Signature

Parameters

appId

Type: String

Return Value

Type: void

Signature

Parameters

appType

Type: String

Return Value

Type: void

Signature

Parameters

changeType

Type: String

Return Value

Type: void

Signature

Parameters

channel

Type: String

Return Value

Type: void

Signature

Parameters

dateValue

Type: Integer

Return Value

Type: void

Signature

Parameters

reason

Type: String

Return Value

Type: void

Signature

Parameters

resolution

Type: String

Return Value

Type: void

Signature

Parameters

rssFeed

Type: Boolean

Return Value

Type: void

Signature

Parameters

rssFeedChangeType

Type: String

Return Value

Type: void

Signature

Parameters

rssFeedTitle

Type: String

Return Value

Type: void

Signature

Parameters

rssFeedUrl

Type: String

Return Value

Type: void

Signature

Parameters

scope

Type: String

Return Value

Type: void

Signature

Parameters

serviceId

Type: String

Return Value

Type: void

Signature

Parameters

serviceType

Type: String

Return Value

Type: void

Signature

Parameters

userId

Type: String

Return Value

Type: void

Signature

Parameters

userName

Type: String

Return Value

Type: void

Represents an access log entry that contains information about a user accessing Slack, IP address, and user agent combination.

Usage

See Slack's team.accessLogs method.

The following are methods for Login.

Signature

Return Value

Type: Integer

Gets the best guess on the country where the access originated, based on the IP address.

Signature

Return Value

Type: String

Gets the unix timestamp of the first access log entry for the user, IP address, and user agent combination.

Signature

Return Value

Type: Integer

Get the most recent unix timestamp for the access log entry.

Signature

Return Value

Type: Integer

Gets the IP address of the device that's used for the user access.

Signature

Return Value

Type: String

Gets Slack's best guess at the internet service provider owning the IP address.

Signature

Return Value

Type: String

Gets the best guess on the region where the access originated, based on the IP address.

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Parameters

count

Type: Integer

Return Value

Type: void

Signature

Parameters

country

Type: String

Return Value

Type: void

Signature

Parameters

dateFirst

Type: Integer

Return Value

Type: void

Signature

Parameters

dateLast

Type: Integer

Return Value

Type: void

Signature

Parameters

ip

Type: String

Return Value

Type: void

Signature

Parameters

isp

Type: String

Return Value

Type: void

Signature

Parameters

region

Type: String

Return Value

Type: void

Signature

Parameters

userAgent

Type: String

Return Value

Type: void

Signature

Parameters

userId

Type: String

Return Value

Type: void

Signature

Parameters

username

Type: String

Return Value

Type: void

Sends a request to get the access logs for the current team.

Usage

See Slack’s team.accessLogs method.

The following are methods for TeamAccessLogsRequest.

Builds a request object that's used when executing the API call.

Signature

Return Value

Type: Slack.TeamAccessLogsRequest.Builder

Contains methods to build an instance of the Slack.TeamAccessLogsRequest class.

A Builder object is obtained by invoking one of the TeamAccessLogsRequest.builder methods defined by the TeamAccessLogsRequest class.

The following are methods for TeamAccessLogsRequest.Builder. These methods are optional unless specified otherwise.

End of time range of logs to include in results (inclusive). The default is now.

Signature

Parameters

before

Type: Integer

Return Value

Type: Slack.TeamAccessLogsRequest.Builder

Required. Returns an instance of Slack.TeamAccessLogsRequest.

Signature

Return Value

Type: Slack.TeamAccessLogsRequest

Number of items to return per page. The default is 100.

Signature

Parameters

count

Type: Integer

Return Value

Type: Slack.TeamAccessLogsRequest.Builder

Page number of results to return. The default is 1.

Signature

Parameters

page

Type: Integer

Return Value

Type: Slack.TeamAccessLogsRequest.Builder

The encoded team ID to get logs from, which is required if an org token is used.

Signature

Parameters

teamId

Type: String

Return Value

Type: Slack.TeamAccessLogsRequest.Builder

Gets the access logs for the current team.

Usage

See Slack’s team.accessLogs method.

This class contains standard response methods.

The following are methods for TeamAccessLogsResponse.

Signature

Return Value

Type: List<Slack.Login>

Signature

Return Value

Type: Slack.Paging

Signature

Parameters

logins

Type: List<Slack.Login>

Return Value

Type: void

Signature

Parameters

paging

Type: Slack.Paging

Return Value

Type: void

Sends a request to get billable users information for the current team.

Usage

See Slack's team.billableInfo method.

The following are methods for TeamBillableInfoRequest.

Builds a request object that's used when executing the API call.

Signature

Return Value

Type: Slack.TeamBillableInfoRequest.Builder

Contains methods to build an instance of the Slack.TeamBillableInfoRequest class.

A Builder object is obtained by invoking one of the TeamBillableInfoRequest.builder methods defined by the TeamBillableInfoRequest class.

The following are methods for TeamBillableInfoRequest.Builder. These methods are optional unless specified otherwise.

Required. Returns an instance of Slack.TeamBillableInfoRequest.

Signature

Return Value

Type: Slack.TeamBillableInfoRequest

The encoded team ID to get billable information from, which is required if an org token is used.

Signature

Parameters

teamId

Type: String

A user to retrieve the billable information for. The default is to return all users.

Signature

Parameters

user

Type: String

Return Value

Type: Slack.TeamBillableInfoRequest.Builder

Gets billable users information for the current team.

Usage

See Slack's team.billableInfo method.

This class contains standard response methods.

The following are methods for TeamBillableInfoResponse.

Signature

Return Value

Type: Map<String,Slack.BillableInfo>

Signature

Parameters

billableInfo

Type: Map<String,Slack.BillableInfo>

Return Value

Type: void

Sends a request to get information about the current team.

Usage

See Slack’s team.info method.

The following are methods for TeamInfoRequest.

Builds a request object that's used when executing the API call.

Signature

Return Value

Type: Slack.TeamInfoRequest.Builder

Contains methods to build an instance of the Slack.TeamInfoRequest class.

A Builder object is obtained by invoking one of the TeamInfoRequest.builder methods defined by the TeamInfoRequest class.

The following are methods for TeamInfoRequest.Builder. These methods are optional unless specified otherwise.

Required. Returns an instance of the Slack.TeamInfoRequest object.

Signature

Return Value

Type: Slack.TeamInfoRequest

Signature

Parameters team

Type: String

Return Value

Type: Slack.TeamInfoRequest.Builder

Gets information about the current team.

Usage

See Slack’s team.info method.

This class contains standard response methods.

The following are methods for TeamInfoResponse.

Signature

Return Value

Type: Slack.Team

Signature

Parameters

team

Type: Slack.Team

Return Value

Type: void

Sends a request to get the integration logs for the current team.

Usage

See Slack’s team.integrationLogs method.

The following are methods for TeamIntegrationLogsRequest.

Builds a request object that's used when executing the API call. Signature

Return Value

Type: Slack.TeamIntegrationLogsRequest.Builder

Contains methods to build an instance of the Slack.TeamIntegrationLogsRequest class.

A Builder object is obtained by invoking one of the TeamIntegrationLogsRequest.builder methods defined by the TeamIntegrationLogsRequest class.

The following are methods for TeamIntegrationLogsRequest.Builder. These methods are optional unless specified otherwise.

Filters logs using the ID of this Slack app. The default is to return all logs.

Signature

Parameters

appId

Type: String

Return Value

Type: Slack.TeamIntegrationLogsRequest.Builder

Required. Returns an instance of the Slack.TeamIntegrationLogsRequest object.

Signature

Return Value

Type: Slack.TeamIntegrationLogsRequest

Filters logs using this change type. Valid values are added, removed, enabled, disabled, and updated. The default is to return all logs.

Signature

Parameters

changeType

Type: String

Return Value

Type: Slack.TeamIntegrationLogsRequest.Builder

The number of items to return per page. The default is 100.

Signature

Parameters

count

Type: Integer

Return Value

Type: Slack.TeamIntegrationLogsRequest.Builder

The page number of results to return. The default is 1.

Signature

Parameters

page

Type: Integer

Return Value

Type: Slack.TeamIntegrationLogsRequest.Builder

Filters logs using this service. The default is to return all logs.

Signature

Parameters

serviceId

Type: String

Return Value

Type: Slack.TeamIntegrationLogsRequest.Builder

The encoded team ID to get logs from, which is required if an org token is used.

Signature

Parameters

teamId

Type: String

Return Value

Type: Slack.TeamIntegrationLogsRequest.Builder

Filters logs generated by this user’s actions. The default is to return all logs.

Signature

Parameters

user

Type: String

Return Value

Type: Slack.TeamIntegrationLogsRequest.Builder

Gets the integration logs for the current team.

Usage

See Slack’s team.integrationLogs method.

This class contains standard response methods.

The following are methods for TeamIntegrationLogsResponse.

Signature

Return Value

Type: List<Slack.IntegrationLog>

Signature

Return Value

Type: Slack.Paging

Signature

Parameters

logs

Type: List<Slack.IntegrationLog>

Return Value

Type: void

Signature

Parameters

paging

Type: Slack.Paging

Return Value

Type: void

Sends a request to retrieve a team's profile.

Usage

See Slack’s team.profile.get method.

The following are methods for TeamProfileGetRequest.

Builds a request object that's used when executing the API call.

Signature

Return Value

Type: Slack.TeamProfileGetRequest.Builder

Contains methods to build an instance of the Slack.TeamProfileGetRequest class.

A Builder object is obtained by invoking one of the TeamProfileGetRequest.builder methods defined by the TeamProfileGetRequest class.

The following are methods for TeamProfileGetRequest.Builder. These methods are optional unless specified otherwise.

Required. Returns an instance of Slack.TeamProfileGetRequest.

Signature

Return Value

Type: Slack.TeamProfileGetRequest

Signature

Parameters

teamId

Type: String

Return Value

Type: Slack.TeamProfileGetRequest.Builder

Filters by visibility. Valid values are all, visible, or hidden. The default is all.

Signature

Parameters

visibility

Type: String

Return Value

Type: Slack.TeamProfileGetRequest.Builder

Retrieve a team's profile.

Usage

See Slack’s team.profile.get method.

This class contains standard response methods.

The following are methods for TeamProfileGetResponse.

Gets the team’s profile.

Signature

Return Value

Type: Slack.TeamProfileGetResponse.Profiles

Signature

Parameters

profile

Type: Slack.TeamProfileGetResponse.Profiles

Return Value

Type: void