Slackconnector v1.0

/admin.apps.approve

Approve an app for installation on a workspace.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`App Id`	The id of the app to approve.
`Request Id`	The id of the request to approve.
`Team Id`	The ID of the workspace to approve the app for.

/admin.apps.approved.list

List approved apps for an org or workspace.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Token`	(Required) Authentication token. Requires scope: admin.apps:read
`Limit`	The maximum number of items to return. Must be between 1 - 1000 both inclusive.
`Cursor`	Set cursor to next_cursor returned by the previous call to list items in the next page
`Team Id`	The workspace ID to filter the approved apps list.
`Enterprise Id`	The enterprise ID to filter the approved apps list.
`Response Type`	The response format expected from the API (e.g. application/json).

/admin.apps.requests.list

List app requests for a team/workspace.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Token`	(Required) Authentication token. Requires scope: admin.apps:read
`Limit`	The maximum number of items to return. Must be between 1 - 1000 both inclusive.
`Cursor`	Set cursor to next_cursor returned by the previous call to list items in the next page
`Team Id`	The workspace ID to filter the requests list.
`Response Type`	The response format expected from the API (e.g. application/json).

/admin.apps.restrict

Restrict an app for installation on a workspace.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`App Id`	The id of the app to restrict.
`Request Id`	The id of the request to restrict.
`Team Id`	The ID of the workspace to restrict the app from.

/admin.apps.restricted.list

List restricted apps for an org or workspace.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Token`	(Required) Authentication token. Requires scope: admin.apps:read
`Limit`	The maximum number of items to return. Must be between 1 - 1000 both inclusive.
`Cursor`	Set cursor to next_cursor returned by the previous call to list items in the next page
`Team Id`	The workspace ID to filter the restricted apps list.
`Enterprise Id`	The enterprise ID to filter the restricted apps list.
`Response Type`	The response format expected from the API (e.g. application/json).

/admin.conversations.archive

Archive a public or private channel.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Channel Id`	The channel to archive.

/admin.conversations.convertToPrivate

Convert a public channel to a private channel.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Channel Id`	The channel to convert to private.

/admin.conversations.create

Create a public or private channel-based conversation.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (5)

Option Name	Description
`Name`	Name of the public or private channel to create.
`Is Private`	When true, creates a private channel instead of a public channel
`Description`	Description of the public or private channel to create.
`Org Wide`	When true, the channel will be available org-wide. Note: if the channel is not org_wide=true, you must specify a team_id for this channel
`Team Id`	The workspace to create the channel in. Note: this argument is required unless you set org_wide=true.

/admin.conversations.delete

Delete a public or private channel.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Channel Id`	The channel to delete.

/admin.conversations.disconnectShared

Disconnect a connected channel from one or more workspaces.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Channel Id`	The channel to be disconnected from some workspaces.
`Leaving Team Ids`	The team to be removed from the channel. Currently only a single team id can be specified.

/admin.conversations.ekm.listOriginalConnectedChannelInfo

List all disconnected channels—i.e., channels that were once connected to other workspaces and then disconnected—and the corresponding original channel IDs for key revocation with EKM.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Token`	(Required) Authentication token. Requires scope: admin.conversations:read
`Channel Ids`	A comma-separated list of channels to filter to.
`Team Ids`	A comma-separated list of the workspaces to which the channels you would like returned belong.
`Limit`	The maximum number of items to return. Must be between 1 - 1000 both inclusive.
`Cursor`	Set cursor to next_cursor returned by the previous call to list items in the next page.
`Response Type`	The response format expected from the API (e.g. application/json).

/admin.conversations.getConversationPrefs

Get conversation preferences for a public or private channel.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Channel Id`	(Required) The channel to get preferences for.
`Token`	(Required) Authentication token. Requires scope: admin.conversations:read
`Response Type`	The response format expected from the API (e.g. application/json).

/admin.conversations.getTeams

Get all the workspaces a given public or private channel is connected to within this Enterprise org.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Channel Id`	(Required) The channel to determine connected workspaces within the organization for.
`Cursor`	Set cursor to next_cursor returned by the previous call to list items in the next page
`Limit`	The maximum number of items to return. Must be between 1 - 1000 both inclusive.
`Token`	(Required) Authentication token. Requires scope: admin.conversations:read
`Response Type`	The response format expected from the API (e.g. application/json).

/admin.conversations.invite

Invite a user to a public or private channel.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`User Ids`	The users to invite.
`Channel Id`	The channel that the users will be invited to.

/admin.conversations.rename

Rename a public or private channel.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Channel Id`	The channel to rename.
`Name`	The new name to assign to the conversation.

/admin.conversations.restrictAccess.addGroup

Add an allowlist of IDP groups for accessing a channel

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (4)

Option Name	Description
`Token`	Authentication token. Requires scope: admin.conversations:write
`Group Id`	The IDP Group ID to be an allowlist for the private channel.
`Channel Id`	The channel to link this group to.
`Team Id`	The workspace where the channel exists. This argument is required for channels only tied to one workspace, and optional for channels that are shared across an organization.

/admin.conversations.restrictAccess.listGroups

List all IDP Groups linked to a channel

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Token`	(Required) Authentication token. Requires scope: admin.conversations:read
`Channel Id`	(Required)
`Team Id`	The workspace where the channel exists. This argument is required for channels only tied to one workspace, and optional for channels that are shared across an organization.
`Response Type`	The response format expected from the API (e.g. application/json).

/admin.conversations.restrictAccess.removeGroup

Remove a linked IDP group linked from a private channel

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (4)

Option Name	Description
`Token`	Authentication token. Requires scope: admin.conversations:write
`Team Id`	The workspace where the channel exists. This argument is required for channels only tied to one workspace, and optional for channels that are shared across an organization.
`Group Id`	The IDP Group ID to remove from the private channel.
`Channel Id`	The channel to remove the linked group from.

/admin.conversations.search

Search for public or private channels in an Enterprise organization.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Team Ids`	Comma separated string of team IDs, signifying the workspaces to search through.
`Query`	Name of the the channel to query by.
`Limit`	Maximum number of items to be returned. Must be between 1 - 20 both inclusive. Default is 10.
`Cursor`	Set cursor to next_cursor returned by the previous call to list items in the next page.
`Search Channel Types`	The type of channel to include or exclude in the search. For example private will search private channels, while private_exclude will exclude them. For a full list of types, check the Types section.
`Sort`	Possible values are relevant (search ranking based on what we think is closest), name (alphabetical), member_count (number of users in the channel), and created (date channel was created). You can optionally pair this with the sort_dir arg to change how it is sorted
`Sort Dir`	Sort direction. Possible values are asc for ascending order like (1, 2, 3) or (a, b, c), and desc for descending order like (3, 2, 1) or (c, b, a)
`Token`	(Required) Authentication token. Requires scope: admin.conversations:read
`Response Type`	The response format expected from the API (e.g. application/json).

/admin.conversations.setConversationPrefs

Set the posting permissions for a public or private channel.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Token`	(Required) Authentication token. Requires scope: admin.conversations:write
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Channel Id`	The channel to set the prefs for
`Prefs`	The prefs for this channel in a stringified JSON format.

/admin.conversations.setTeams

Set the workspaces in an Enterprise grid org that connect to a public or private channel.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (4)

Option Name	Description
`Channel Id`	The encoded channel_id to add or remove to workspaces.
`Team Id`	The workspace to which the channel belongs. Omit this argument if the channel is a cross-workspace shared channel.
`Target Team Ids`	A comma-separated list of workspaces to which the channel should be shared. Not required if the channel is being shared org-wide.
`Org Channel`	True if channel has to be converted to an org channel

/admin.conversations.unarchive

Unarchive a public or private channel.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Channel Id`	The channel to unarchive.

/admin.emoji.add

Add an emoji.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Token`	Authentication token. Requires scope: admin.teams:write
`Name`	The name of the emoji to be removed. Colons (:myemoji:) around the value are not required, although they may be included.
`Url`	The URL of a file to use as an image for the emoji. Square images under 128KB and with transparent backgrounds work best.

/admin.emoji.addAlias

Add an emoji alias.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Token`	Authentication token. Requires scope: admin.teams:write
`Name`	The name of the emoji to be aliased. Colons (:myemoji:) around the value are not required, although they may be included.
`Alias For`	The alias of the emoji.

/admin.emoji.list

List emoji for an Enterprise Grid organization.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Token`	(Required) Authentication token. Requires scope: admin.teams:read
`Cursor`	Set cursor to next_cursor returned by the previous call to list items in the next page
`Limit`	The maximum number of items to return. Must be between 1 - 1000 both inclusive.
`Response Type`	The response format expected from the API (e.g. application/json).

/admin.emoji.remove

Remove an emoji across an Enterprise Grid organization

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Token`	Authentication token. Requires scope: admin.teams:write
`Name`	The name of the emoji to be removed. Colons (:myemoji:) around the value are not required, although they may be included.

/admin.emoji.rename

Rename an emoji.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Token`	Authentication token. Requires scope: admin.teams:write
`Name`	The name of the emoji to be renamed. Colons (:myemoji:) around the value are not required, although they may be included.
`New Name`	The new name of the emoji.

/admin.inviteRequests.approve

Approve a workspace invite request.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Invite Request Id`	ID of the request to invite.
`Team Id`	ID for the workspace where the invite request was made.

/admin.inviteRequests.approved.list

List all approved workspace invite requests.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Team Id`	ID for the workspace where the invite requests were made.
`Cursor`	Value of the next_cursor field sent as part of the previous API response
`Limit`	The number of results that will be returned by the API on each invocation. Must be between 1 - 1000, both inclusive
`Token`	(Required) Authentication token. Requires scope: admin.invites:read
`Response Type`	The response format expected from the API (e.g. application/json).

/admin.inviteRequests.denied.list

List all denied workspace invite requests.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Team Id`	ID for the workspace where the invite requests were made.
`Cursor`	Value of the next_cursor field sent as part of the previous api response
`Limit`	The number of results that will be returned by the API on each invocation. Must be between 1 - 1000 both inclusive
`Token`	(Required) Authentication token. Requires scope: admin.invites:read
`Response Type`	The response format expected from the API (e.g. application/json).

/admin.inviteRequests.deny

Deny a workspace invite request.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Invite Request Id`	ID of the request to invite.
`Team Id`	ID for the workspace where the invite request was made.

/admin.inviteRequests.list

List all pending workspace invite requests.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Team Id`	ID for the workspace where the invite requests were made.
`Cursor`	Value of the next_cursor field sent as part of the previous API response
`Limit`	The number of results that will be returned by the API on each invocation. Must be between 1 - 1000, both inclusive
`Token`	(Required) Authentication token. Requires scope: admin.invites:read
`Response Type`	The response format expected from the API (e.g. application/json).

/admin.teams.admins.list

List all of the admins on a given workspace.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Token`	(Required) Authentication token. Requires scope: admin.teams:read
`Limit`	The maximum number of items to return.
`Cursor`	Set cursor to next_cursor returned by the previous call to list items in the next page.
`Team Id`	(Required)
`Response Type`	The response format expected from the API (e.g. application/json).

/admin.teams.create

Create an Enterprise team.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (4)

Option Name	Description
`Team Domain`	Team domain (for example, slacksoftballteam).
`Team Name`	Team name (for example, Slack Softball Team).
`Team Description`	Description for the team.
`Team Discoverability`	Who can join the team. A team's discoverability can be open, closed, invite_only, or unlisted.

/admin.teams.list

List all teams on an Enterprise organization

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Limit`	The maximum number of items to return. Must be between 1 - 100 both inclusive.
`Cursor`	Set cursor to next_cursor returned by the previous call to list items in the next page.
`Token`	(Required) Authentication token. Requires scope: admin.teams:read
`Response Type`	The response format expected from the API (e.g. application/json).

/admin.teams.owners.list

List all of the owners on a given workspace.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Token`	(Required) Authentication token. Requires scope: admin.teams:read
`Team Id`	(Required)
`Limit`	The maximum number of items to return. Must be between 1 - 1000 both inclusive.
`Cursor`	Set cursor to next_cursor returned by the previous call to list items in the next page.
`Response Type`	The response format expected from the API (e.g. application/json).

/admin.teams.settings.info

Fetch information about settings in a workspace

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Team Id`	(Required)
`Token`	(Required) Authentication token. Requires scope: admin.teams:read
`Response Type`	The response format expected from the API (e.g. application/json).

/admin.teams.settings.setDefaultChannels

Set the default channels of a workspace.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Token`	Authentication token. Requires scope: admin.teams:write
`Team Id`	ID for the workspace to set the default channel for.
`Channel Ids`	An array of channel IDs.

/admin.teams.settings.setDescription

Set the description of a given workspace.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Team Id`	ID for the workspace to set the description for.
`Description`	The new description for the workspace.

/admin.teams.settings.setDiscoverability

An API method that allows admins to set the discoverability of a given workspace

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Team Id`	The ID of the workspace to set discoverability on.
`Discoverability`	This workspace's discovery setting. It must be set to one of open, invite_only, closed, or unlisted.

/admin.teams.settings.setIcon

Sets the icon of a workspace.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Token`	Authentication token. Requires scope: admin.teams:write
`Image Url`	Image URL for the icon
`Team Id`	ID for the workspace to set the icon for.

/admin.teams.settings.setName

Set the name of a given workspace.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Team Id`	ID for the workspace to set the name for.
`Name`	The new name of the workspace.

/admin.usergroups.addChannels

Add one or more default channels to an IDP group.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Usergroup Id`	ID of the IDP group to add default channels for.
`Channel Ids`	Comma separated string of channel IDs.
`Team Id`	The workspace to add default channels in.

/admin.usergroups.addTeams

Associate one or more default workspaces with an organization-wide IDP group.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Usergroup Id`	An encoded usergroup (IDP Group) ID.
`Team Ids`	A comma separated list of encoded team (workspace) IDs. Each workspace MUST belong to the organization associated with the token.
`Auto Provision`	When true, this method automatically creates new workspace accounts for the IDP group members.

/admin.usergroups.listChannels

List the channels linked to an org-level IDP group (user group).

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Usergroup Id`	(Required) ID of the IDP group to list default channels for.
`Team Id`	ID of the the workspace.
`Include Num Members`	Flag to include or exclude the count of members per channel.
`Token`	(Required) Authentication token. Requires scope: admin.usergroups:read
`Response Type`	The response format expected from the API (e.g. application/json).

/admin.usergroups.removeChannels

Remove one or more default channels from an org-level IDP group (user group).

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Usergroup Id`	ID of the IDP Group
`Channel Ids`	Comma-separated string of channel IDs

/admin.users.assign

Add an Enterprise user to a workspace.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (5)

Option Name	Description
`Team Id`	The ID (T1234) of the workspace.
`User Id`	The ID of the user to add to the workspace.
`Is Restricted`	True if user should be added to the workspace as a guest.
`Is Ultra Restricted`	True if user should be added to the workspace as a single-channel guest.
`Channel Ids`	Comma separated values of channel IDs to add user in the new workspace.

/admin.users.invite

Invite a user to a workspace.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (9)

Option Name	Description
`Team Id`	The ID (T1234) of the workspace.
`Email`	The email address of the person to invite.
`Channel Ids`	A comma-separated list of channel_ids for this user to join. At least one channel is required.
`Custom Message`	An optional message to send to the user in the invite email.
`Real Name`	Full name of the user.
`Resend`	Allow this invite to be resent in the future if a user has not signed up yet. (default: false)
`Is Restricted`	Is this user a multi-channel guest user? (default: false)
`Is Ultra Restricted`	Is this user a single channel guest user? (default: false)
`Guest Expiration Ts`	Timestamp when guest account should be disabled. Only include this timestamp if you are inviting a guest user and you want their account to expire on a certain date.

/admin.users.list

List users on a workspace

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Team Id`	(Required) The ID (T1234) of the workspace.
`Cursor`	Set cursor to next_cursor returned by the previous call to list items in the next page.
`Limit`	Limit for how many users to be retrieved per page
`Token`	(Required) Authentication token. Requires scope: admin.users:read
`Response Type`	The response format expected from the API (e.g. application/json).

/admin.users.remove

Remove a user from a workspace.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Team Id`	The ID (T1234) of the workspace.
`User Id`	The ID of the user to remove.

/admin.users.session.invalidate

Invalidate a single session for a user by session_id

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Team Id`	ID of the team that the session belongs to
`Session Id`	The ID of the session to invalidate.

/admin.users.session.reset

Wipes all valid sessions on all devices for a given user

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`User Id`	The ID of the user to wipe sessions for
`Mobile Only`	Only expire mobile sessions (default: false)
`Web Only`	Only expire web sessions (default: false)

/admin.users.setAdmin

Set an existing guest, regular user, or owner to be an admin user.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Team Id`	The ID (T1234) of the workspace.
`User Id`	The ID of the user to designate as an admin.

/admin.users.setExpiration

Set an expiration for a guest user

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Team Id`	The ID (T1234) of the workspace.
`User Id`	The ID of the user to set an expiration for.
`Expiration Ts`	Timestamp when guest account should be disabled.

/admin.users.setOwner

Set an existing guest, regular user, or admin user to be a workspace owner.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Team Id`	The ID (T1234) of the workspace.
`User Id`	Id of the user to promote to owner.

/admin.users.setRegular

Set an existing guest user, admin user, or owner to be a regular user.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Team Id`	The ID (T1234) of the workspace.
`User Id`	The ID of the user to designate as a regular user.

x-oneteg-downloader-path-without-authorization

Download an asset from a URL without requiring authorization.

Parameters

Parameter Name	Description
`HTTP Method`	The HTTP method to use for the download request.
`Download Url`	The URL from which to download the asset.
`Asset Name`	The name to assign to the downloaded asset.
`Try Count`	The number of times to retry the download if it fails.
`Read Timeout (seconds)`	The maximum time in seconds to wait for data to be read.
`Connection Timeout (seconds)`	The maximum time in seconds to wait for a connection to be established.
`Load File Content As Output`	This toggle enables you to load file content as the step output. Supported formats include JSON, XML, YML/YAML, CSV, TXT, and other text-based file types. Note that images, PDF files, and other binary formats cannot be loaded. Additionally, there is a file size limit for this feature; please check the logs for details.
`Follow Redirects`	Enable or disable following URL redirects. If it is enabled, it will follow the URL redirects.
`headers`	Additional HTTP header name/value pairs to include in the request.

/api.test

Checks API calling code.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Error`	Error response to return
`Foo`	example property to return
`Response Type`	The response format expected from the API (e.g. application/json).

/apps.event.authorizations.list

Get a list of authorizations for the given event context. Each authorization represents an app installation that the event is visible to.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Event Context`	(Required)
`Cursor`	A cursor value for paginating through the list of authorizations.
`Limit`	The maximum number of authorizations to return per page.
`Response Type`	The response format expected from the API (e.g. application/json).

/apps.permissions.info

Returns list of permissions this app has on a team.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/apps.permissions.request

Allows an app to request additional scopes

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Scopes`	(Required) A comma separated list of scopes to request for
`Trigger Id`	(Required) Token used to trigger the permissions API
`Response Type`	The response format expected from the API (e.g. application/json).

/apps.permissions.resources.list

Returns list of resource grants this app has on a team.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Cursor`	Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request's response_metadata. Default value fetches the first "page" of the collection. See pagination for more detail.
`Limit`	The maximum number of items to return.
`Response Type`	The response format expected from the API (e.g. application/json).

/apps.permissions.scopes.list

Returns list of scopes this app has on a team.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/apps.permissions.users.list

Returns list of user grants and corresponding scopes this app has on a team.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Cursor`	Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request's response_metadata. Default value fetches the first "page" of the collection. See pagination for more detail.
`Limit`	The maximum number of items to return.
`Response Type`	The response format expected from the API (e.g. application/json).

/apps.permissions.users.request

Enables an app to trigger a permissions modal to grant an app access to a user access scope.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Scopes`	(Required) A comma separated list of user scopes to request for
`Trigger Id`	(Required) Token used to trigger the request
`User`	(Required) The user this scope is being requested for
`Response Type`	The response format expected from the API (e.g. application/json).

/apps.uninstall

Uninstalls your app from a workspace.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Client Id`	Issued when you created your application.
`Client Secret`	Issued when you created your application.
`Response Type`	The response format expected from the API (e.g. application/json).

/auth.revoke

Revokes a token.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Test`	Setting this parameter to 1 triggers a _testing mode_ where the specified token will not actually be revoked.
`Response Type`	The response format expected from the API (e.g. application/json).

/auth.test

Checks authentication & identity.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/bots.info

Gets information about a bot user.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Bot`	Bot user to get info on
`Response Type`	The response format expected from the API (e.g. application/json).

/calls.add

Registers a new Call.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (8)

Option Name	Description
`External Unique Id`	An ID supplied by the 3rd-party Call provider. It must be unique across all Calls from that service.
`Join Url`	The URL required for a client to join the Call.
`External Display Id`	An optional, human-readable ID supplied by the 3rd-party Call provider. If supplied, this ID will be displayed in the Call object.
`Desktop App Join Url`	When supplied, available Slack clients will attempt to directly launch the 3rd-party Call with this URL.
`Date Start`	Call start time in UTC UNIX timestamp format
`Title`	The name of the Call.
`Created By`	The valid Slack user ID of the user who created this Call. When this method is called with a user token, the created_by field is optional and defaults to the authed user of the token. Otherwise, the field is required.
`Users`	The list of users to register as participants in the Call. Read more on how to specify users here.

/calls.end

Ends a Call.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Id`	id returned when registering the call using the calls.add method.
`Duration`	Call duration in seconds

/calls.info

Returns information about a Call.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	(Required) id of the Call returned by the calls.add method.
`Response Type`	The response format expected from the API (e.g. application/json).

/calls.participants.add

Registers new participants added to a Call.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Id`	id returned by the calls.add method.
`Users`	The list of users to add as participants in the Call. Read more on how to specify users here.

/calls.participants.remove

Registers participants removed from a Call.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Id`	id returned by the calls.add method.
`Users`	The list of users to remove as participants in the Call. Read more on how to specify users here.

/calls.update

Updates information about a Call.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (4)

Option Name	Description
`Id`	id returned by the calls.add method.
`Title`	The name of the Call.
`Join Url`	The URL required for a client to join the Call.
`Desktop App Join Url`	When supplied, available Slack clients will attempt to directly launch the 3rd-party Call with this URL.

/chat.delete

Deletes a message.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Ts`	Timestamp of the message to be deleted.
`Channel`	Channel containing the message to be deleted.
`As User`	Pass true to delete the message as the authed user with chat:write:user scope. Bot users in this context are considered authed users. If unused or false, the message will be deleted with chat:write:bot scope.

/chat.deleteScheduledMessage

Deletes a pending scheduled message from the queue.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Channel`	The channel the scheduled_message is posting to
`Scheduled Message Id`	scheduled_message_id returned from call to chat.scheduleMessage
`As User`	Pass true to delete the message as the authed user with chat:write:user scope. Bot users in this context are considered authed users. If unused or false, the message will be deleted with chat:write:bot scope.

/chat.getPermalink

Retrieve a permalink URL for a specific extant message

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Channel`	(Required) The ID of the conversation or channel containing the message
`Message Ts`	(Required) A message's ts value, uniquely identifying it within a channel
`Response Type`	The response format expected from the API (e.g. application/json).

/chat.meMessage

Share a me message into a channel.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Channel`	Channel to send message to. Can be a public channel, private group or IM channel. Can be an encoded ID, or a name.
`Text`	Text of the message to send.

/chat.postEphemeral

Sends an ephemeral message to a user in a channel.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (12)

Option Name	Description
`Channel`	Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name.
`User`	id of the user who will receive the ephemeral message. The user should be in the channel specified by the channel argument.
`As User`	Pass true to post the message as the authed user. Defaults to true if the chat:write:bot scope is not included. Otherwise, defaults to false.
`Attachments`	A JSON-based array of structured attachments, presented as a URL-encoded string.
`Blocks`	A JSON-based array of structured blocks, presented as a URL-encoded string.
`Icon Emoji`	Emoji to use as the icon for this message. Overrides icon_url. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below.
`Icon Url`	URL to an image to use as the icon for this message. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below.
`Link Names`	Find and link channel names and usernames.
`Parse`	Change how messages are treated. Defaults to none. See below.
`Text`	How this field works and whether it is required depends on other fields you use in your API call. See below for more detail.
`Thread Ts`	Provide another message's ts value to post this message in a thread. Avoid using a reply's ts value; use its parent's value instead. Ephemeral messages in threads are only shown if there is already an active thread.
`Username`	Set your bot's user name. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below.

/chat.postMessage

Sends a message to a channel.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (15)

Option Name	Description
`Channel`	Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name. See below for more details.
`As User`	Pass true to post the message as the authed user, instead of as a bot. Defaults to false. See authorship below.
`Attachments`	A JSON-based array of structured attachments, presented as a URL-encoded string.
`Blocks`	A JSON-based array of structured blocks, presented as a URL-encoded string.
`Icon Emoji`	Emoji to use as the icon for this message. Overrides icon_url. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below.
`Icon Url`	URL to an image to use as the icon for this message. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below.
`Link Names`	Find and link channel names and usernames.
`Mrkdwn`	Disable Slack markup parsing by setting to false. Enabled by default.
`Parse`	Change how messages are treated. Defaults to none. See below.
`Reply Broadcast`	Used in conjunction with thread_ts and indicates whether reply should be made visible to everyone in the channel or conversation. Defaults to false.
`Text`	How this field works and whether it is required depends on other fields you use in your API call. See below for more detail.
`Thread Ts`	Provide another message's ts value to make this message a reply. Avoid using a reply's ts value; use its parent instead.
`Unfurl Links`	Pass true to enable unfurling of primarily text-based content.
`Unfurl Media`	Pass false to disable unfurling of media content.
`Username`	Set your bot's user name. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below.

/chat.scheduleMessage

Schedules a message to be sent to a channel.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (12)

Option Name	Description
`Channel`	Channel, private group, or DM channel to send message to. Can be an encoded ID, or a name. See below for more details.
`Text`	How this field works and whether it is required depends on other fields you use in your API call. See below for more detail.
`Post At`	Unix EPOCH timestamp of time in future to send the message.
`Parse`	Change how messages are treated. Defaults to none. See chat.postMessage.
`As User`	Pass true to post the message as the authed user, instead of as a bot. Defaults to false. See chat.postMessage.
`Link Names`	Find and link channel names and usernames.
`Attachments`	A JSON-based array of structured attachments, presented as a URL-encoded string.
`Blocks`	A JSON-based array of structured blocks, presented as a URL-encoded string.
`Unfurl Links`	Pass true to enable unfurling of primarily text-based content.
`Unfurl Media`	Pass false to disable unfurling of media content.
`Thread Ts`	Provide another message's ts value to make this message a reply. Avoid using a reply's ts value; use its parent instead.
`Reply Broadcast`	Used in conjunction with thread_ts and indicates whether reply should be made visible to everyone in the channel or conversation. Defaults to false.

/chat.scheduledMessages.list

Returns a list of scheduled messages.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Channel`	The channel of the scheduled messages
`Latest`	A UNIX timestamp of the latest value in the time range
`Oldest`	A UNIX timestamp of the oldest value in the time range
`Limit`	Maximum number of original entries to return.
`Cursor`	For pagination purposes, this is the cursor value returned from a previous call to chat.scheduledmessages.list indicating where you want to start this call from.
`Response Type`	The response format expected from the API (e.g. application/json).

/chat.unfurl

Provide custom unfurl behavior for user-posted URLs

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (6)

Option Name	Description
`Channel`	Channel ID of the message
`Ts`	Timestamp of the message to add unfurl behavior to.
`Unfurls`	URL-encoded JSON map with keys set to URLs featured in the the message, pointing to their unfurl blocks or message attachments.
`User Auth Message`	Provide a simply-formatted string to send as an ephemeral message to the user as invitation to authenticate further and enable full unfurling behavior
`User Auth Required`	Set to true or 1 to indicate the user must install your Slack app to trigger unfurls for this domain
`User Auth Url`	Send users to this custom URL where they will complete authentication in your app to fully trigger unfurling. Value should be properly URL-encoded.

/chat.update

Updates a message.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (8)

Option Name	Description
`Channel`	Channel containing the message to be updated.
`Ts`	Timestamp of the message to be updated.
`As User`	Pass true to update the message as the authed user. Bot users in this context are considered authed users.
`Attachments`	A JSON-based array of structured attachments, presented as a URL-encoded string. This field is required when not presenting text. If you don't include this field, the message's previous attachments will be retained. To remove previous attachments, include an empty array for this field.
`Blocks`	A JSON-based array of structured blocks, presented as a URL-encoded string. If you don't include this field, the message's previous blocks will be retained. To remove previous blocks, include an empty array for this field.
`Link Names`	Find and link channel names and usernames. Defaults to none. If you do not specify a value for this field, the original value set for the message will be overwritten with the default, none.
`Parse`	Change how messages are treated. Defaults to client, unlike chat.postMessage. Accepts either none or full. If you do not specify a value for this field, the original value set for the message will be overwritten with the default, client.
`Text`	New text for the message, using the default formatting rules. It's not required when presenting blocks or attachments.

/conversations.archive

Archives a conversation.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Channel`	ID of conversation to archive

/conversations.close

Closes a direct message or multi-person direct message.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Channel`	Conversation to close.

/conversations.create

Initiates a public or private channel-based conversation

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Name`	Name of the public or private channel to create
`Is Private`	Create a private channel instead of a public one

/conversations.history

Fetches a conversation's history of messages and events.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Channel`	Conversation ID to fetch history for.
`Latest`	End of time range of messages to include in results.
`Oldest`	Start of time range of messages to include in results.
`Inclusive`	Include messages with latest or oldest timestamp in results only when either timestamp is specified.
`Limit`	The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached.
`Cursor`	Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request's response_metadata. Default value fetches the first "page" of the collection. See pagination for more detail.
`Response Type`	The response format expected from the API (e.g. application/json).

/conversations.info

Retrieve information about a conversation.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Channel`	Conversation ID to learn more about
`Include Locale`	Set this to true to receive the locale for this conversation. Defaults to false
`Include Num Members`	Set to true to include the member count for the specified conversation. Defaults to false
`Response Type`	The response format expected from the API (e.g. application/json).

/conversations.invite

Invites users to a channel.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Channel`	The ID of the public or private channel to invite user(s) to.
`Users`	A comma separated list of user IDs. Up to 1000 users may be listed.

/conversations.join

Joins an existing conversation.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Channel`	ID of conversation to join

/conversations.kick

Removes a user from a conversation.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Channel`	ID of conversation to remove user from.
`User`	User ID to be removed.

/conversations.leave

Leaves a conversation.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Channel`	Conversation to leave

/conversations.list

Lists all channels in a Slack team.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Exclude Archived`	Set to true to exclude archived channels from the list
`Types`	Mix and match channel types by providing a comma-separated list of any combination of public_channel, private_channel, mpim, im
`Limit`	The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached. Must be an integer no larger than 1000.
`Cursor`	Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request's response_metadata. Default value fetches the first "page" of the collection. See pagination for more detail.
`Response Type`	The response format expected from the API (e.g. application/json).

/conversations.mark

Sets the read cursor in a channel.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Channel`	Channel or conversation to set the read cursor for.
`Ts`	Unique identifier of message you want marked as most recently seen in this conversation.

/conversations.members

Retrieve members of a conversation.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Channel`	ID of the conversation to retrieve members for
`Limit`	The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached.
`Cursor`	Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request's response_metadata. Default value fetches the first "page" of the collection. See pagination for more detail.
`Response Type`	The response format expected from the API (e.g. application/json).

/conversations.open

Opens or resumes a direct message or multi-person direct message.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Channel`	Resume a conversation by supplying an im or mpim's ID. Or provide the users field instead.
`Users`	Comma separated lists of users. If only one user is included, this creates a 1:1 DM. The ordering of the users is preserved whenever a multi-person direct message is returned. Supply a channel when not supplying users.
`Return Im`	Boolean, indicates you want the full IM channel definition in the response.

/conversations.rename

Renames a conversation.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Channel`	ID of conversation to rename
`Name`	New name for conversation.

/conversations.replies

Retrieve a thread of messages posted to a conversation

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Channel`	Conversation ID to fetch thread from.
`Ts`	Unique identifier of a thread's parent message. ts must be the timestamp of an existing message with 0 or more replies. If there are no replies then just the single message referenced by ts will return - it is just an ordinary, unthreaded message.
`Latest`	End of time range of messages to include in results.
`Oldest`	Start of time range of messages to include in results.
`Inclusive`	Include messages with latest or oldest timestamp in results only when either timestamp is specified.
`Limit`	The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached.
`Cursor`	Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request's response_metadata. Default value fetches the first "page" of the collection. See pagination for more detail.
`Response Type`	The response format expected from the API (e.g. application/json).

/conversations.setPurpose

Sets the purpose for a conversation.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Channel`	Conversation to set the purpose of
`Purpose`	A new, specialer purpose

/conversations.setTopic

Sets the topic for a conversation.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Channel`	Conversation to set the topic of
`Topic`	The new topic string. Does not support formatting or linkification.

/conversations.unarchive

Reverses conversation archival.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Channel`	ID of conversation to unarchive

/dialog.open

Open a dialog with a user

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Dialog`	(Required) The dialog definition. This must be a JSON-encoded string.
`Trigger Id`	(Required) Exchange a trigger to post to the user.
`Response Type`	The response format expected from the API (e.g. application/json).

/dnd.endDnd

Ends the current user's Do Not Disturb session immediately.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/dnd.endSnooze

Ends the current user's snooze mode immediately.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/dnd.info

Retrieves a user's current Do Not Disturb status.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`User`	User to fetch status for (defaults to current user)
`Response Type`	The response format expected from the API (e.g. application/json).

/dnd.setSnooze

Turns on Do Not Disturb mode for the current user, or changes its duration.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Token`	Authentication token. Requires scope: dnd:write
`Num Minutes`	Number of minutes, from now, to snooze until.

/dnd.teamInfo

Retrieves the Do Not Disturb status for up to 50 users on a team.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Users`	Comma-separated list of users to fetch Do Not Disturb status for
`Response Type`	The response format expected from the API (e.g. application/json).

/emoji.list

Lists custom emoji for a team.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/files.comments.delete

Deletes an existing comment on a file.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`File`	File to delete a comment from.
`Id`	The comment to delete.

/files.delete

Deletes a file.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`File`	ID of file to delete.

/files.info

Gets information about a file.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`File`	Specify a file by providing its ID.
`Count`	The number of items to return per page.
`Page`	The page number to retrieve.
`Limit`	The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached.
`Cursor`	Parameter for pagination. File comments are paginated for a single file. Set cursor equal to the next_cursor attribute returned by the previous request's response_metadata. This parameter is optional, but pagination is mandatory: the default value simply fetches the first "page" of the collection of comments. See pagination for more details.
`Response Type`	The response format expected from the API (e.g. application/json).

/files.list

List for a team, in a channel, or from a user with applied filters.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`User`	Filter files created by a single user.
`Channel`	Filter files appearing in a specific channel, indicated by its ID.
`Ts From`	Filter files created after this timestamp (inclusive).
`Ts To`	Filter files created before this timestamp (inclusive).
`Types`	Filter files by type (see below). You can pass multiple values in the types argument, like types=spaces,snippets.The default value is all, which does not filter the list.
`Count`	The number of files to return per page.
`Page`	The page number to retrieve.
`Show Files Hidden By Limit`	Show truncated file info for files hidden due to being too old, and the team who owns the file being over the file limit.
`Response Type`	The response format expected from the API (e.g. application/json).

/files.remote.add

Adds a file from a remote service

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (7)

Option Name	Description
`Token`	Authentication token. Requires scope: remote_files:write
`External Id`	Creator defined GUID for the file.
`Title`	Title of the file being shared.
`Filetype`	type of file
`External Url`	URL of the remote file.
`Preview Image`	Preview of the document via multipart/form-data.
`Indexable File Contents`	A text file (txt, pdf, doc, etc.) containing textual search terms that are used to improve discovery of the remote file.

/files.remote.info

Retrieve information about a remote file added to Slack

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`File`	Specify a file by providing its ID.
`External Id`	Creator defined GUID for the file.
`Response Type`	The response format expected from the API (e.g. application/json).

/files.remote.list

Retrieve information about a remote file added to Slack

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Channel`	Filter files appearing in a specific channel, indicated by its ID.
`Ts From`	Filter files created after this timestamp (inclusive).
`Ts To`	Filter files created before this timestamp (inclusive).
`Limit`	The maximum number of items to return.
`Cursor`	Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request's response_metadata. Default value fetches the first "page" of the collection. See pagination for more detail.
`Response Type`	The response format expected from the API (e.g. application/json).

/files.remote.remove

Remove a remote file.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Token`	Authentication token. Requires scope: remote_files:write
`File`	Specify a file by providing its ID.
`External Id`	Creator defined GUID for the file.

/files.remote.share

Share a remote file into a channel.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`File`	Specify a file registered with Slack by providing its ID. Either this field or external_id or both are required.
`External Id`	The globally unique identifier (GUID) for the file, as set by the app registering the file with Slack. Either this field or file or both are required.
`Channels`	Comma-separated list of channel IDs where the file will be shared.
`Response Type`	The response format expected from the API (e.g. application/json).

/files.remote.update

Updates an existing remote file.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (8)

Option Name	Description
`Token`	Authentication token. Requires scope: remote_files:write
`File`	Specify a file by providing its ID.
`External Id`	Creator defined GUID for the file.
`Title`	Title of the file being shared.
`Filetype`	type of file
`External Url`	URL of the remote file.
`Preview Image`	Preview of the document via multipart/form-data.
`Indexable File Contents`	File containing contents that can be used to improve searchability for the remote file.

/files.revokePublicURL

Revokes public/external sharing access for a file

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`File`	File to revoke

/files.sharedPublicURL

Enables a file for public/external sharing.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`File`	File to share

/files.upload

Uploads or creates a file.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Content-type`	The MIME type of the file being uploaded.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (8)

Option Name	Description
`File`	File contents via multipart/form-data. If omitting this parameter, you must submit content.
`Content`	File contents via a POST variable. If omitting this parameter, you must provide a file.
`Filetype`	A file type identifier.
`Filename`	Filename of file.
`Title`	Title of file.
`Initial Comment`	The message text introducing the file in specified channels.
`Channels`	Comma-separated list of channel names or IDs where the file will be shared.
`Thread Ts`	Provide another message's ts value to upload this file as a reply. Never use a reply's ts value; use its parent instead.

/migration.exchange

For Enterprise Grid workspaces, map local user IDs to global user IDs

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Users`	(Required) A comma-separated list of user ids, up to 400 per request
`Team Id`	Specify team_id starts with T in case of Org Token
`To Old`	Specify true to convert W global user IDs to workspace-specific U IDs. Defaults to false.
`Response Type`	The response format expected from the API (e.g. application/json).

/oauth.access

Exchanges a temporary OAuth verifier code for an access token.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Client Id`	Issued when you created your application.
`Client Secret`	Issued when you created your application.
`Code`	The code param returned via the OAuth callback.
`Redirect Uri`	This must match the originally submitted URI (if one was sent).
`Single Channel`	Request the user to add your app only to a single channel. Only valid with a legacy workspace app.
`Response Type`	The response format expected from the API (e.g. application/json).

/oauth.token

Exchanges a temporary OAuth verifier code for a workspace token.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Client Id`	Issued when you created your application.
`Client Secret`	Issued when you created your application.
`Code`	The code param returned via the OAuth callback.
`Redirect Uri`	This must match the originally submitted URI (if one was sent).
`Single Channel`	Request the user to add your app only to a single channel.
`Response Type`	The response format expected from the API (e.g. application/json).

/oauth.v2.access

Exchanges a temporary OAuth verifier code for an access token.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Client Id`	Issued when you created your application.
`Client Secret`	Issued when you created your application.
`Code`	(Required) The code param returned via the OAuth callback.
`Redirect Uri`	This must match the originally submitted URI (if one was sent).
`Response Type`	The response format expected from the API (e.g. application/json).

/pins.add

Pins an item to a channel.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Channel`	Channel to pin the item in.
`Timestamp`	Timestamp of the message to pin.

/pins.list

Lists items pinned to a channel.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Channel`	(Required) Channel to get pinned items for.
`Response Type`	The response format expected from the API (e.g. application/json).

/pins.remove

Un-pins an item from a channel.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Channel`	Channel where the item is pinned to.
`Timestamp`	Timestamp of the message to un-pin.

/reactions.add

Adds a reaction to an item.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Channel`	Channel where the message to add reaction to was posted.
`Name`	Reaction (emoji) name.
`Timestamp`	Timestamp of the message to add reaction to.

/reactions.get

Gets reactions for an item.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Channel`	Channel where the message to get reactions for was posted.
`File`	File to get reactions for.
`File Comment`	File comment to get reactions for.
`Full`	If true always return the complete reaction list.
`Timestamp`	Timestamp of the message to get reactions for.
`Response Type`	The response format expected from the API (e.g. application/json).

/reactions.list

Lists reactions made by a user.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`User`	Show reactions made by this user. Defaults to the authed user.
`Full`	If true always return the complete reaction list.
`Count`	The number of reactions to return per page.
`Page`	The page number to retrieve.
`Cursor`	Parameter for pagination. Set cursor equal to the next_cursor attribute returned by the previous request's response_metadata. This parameter is optional, but pagination is mandatory: the default value simply fetches the first "page" of the collection. See pagination for more details.
`Limit`	The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached.
`Response Type`	The response format expected from the API (e.g. application/json).

/reactions.remove

Removes a reaction from an item.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (5)

Option Name	Description
`Name`	Reaction (emoji) name.
`File`	File to remove reaction from.
`File Comment`	File comment to remove reaction from.
`Channel`	Channel where the message to remove reaction from was posted.
`Timestamp`	Timestamp of the message to remove reaction from.

/reminders.add

Creates a reminder.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Text`	The content of the reminder
`Time`	When this reminder should happen: the Unix timestamp (up to five years from now), the number of seconds until the reminder (if within 24 hours), or a natural language description (Ex. "in 15 minutes," or "every Thursday")
`User`	The user who will receive the reminder. If no user is specified, the reminder will go to user who created it.

/reminders.complete

Marks a reminder as complete.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Reminder`	The ID of the reminder to be marked as complete

/reminders.delete

Deletes a reminder.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Reminder`	The ID of the reminder

/reminders.info

Gets information about a reminder.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Reminder`	The ID of the reminder
`Response Type`	The response format expected from the API (e.g. application/json).

/reminders.list

Lists all reminders created by or for a given user.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/rtm.connect

Starts a Real Time Messaging session.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Batch Presence Aware`	Batch presence deliveries via subscription. Enabling changes the shape of presence_change events. See batch presence.
`Presence Sub`	Only deliver presence events when requested by subscription. See presence subscriptions.
`Response Type`	The response format expected from the API (e.g. application/json).

/search.messages

Searches for messages matching a query.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Count`	Pass the number of results you want per "page". Maximum of 100.
`Highlight`	Pass a value of true to enable query highlight markers (see below).
`Page`	The page number of search results to retrieve.
`Query`	(Required) Search query.
`Sort`	Return matches sorted by either score or timestamp.
`Sort Dir`	Change sort direction to ascending (asc) or descending (desc).
`Response Type`	The response format expected from the API (e.g. application/json).

/stars.add

Adds a star to an item.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (4)

Option Name	Description
`Channel`	Channel to add star to, or channel where the message to add star to was posted (used with timestamp).
`File`	File to add star to.
`File Comment`	File comment to add star to.
`Timestamp`	Timestamp of the message to add star to.

/stars.list

Lists stars for a user.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Count`	The number of starred items to return per page.
`Page`	The page number to retrieve.
`Cursor`	Parameter for pagination. Set cursor equal to the next_cursor attribute returned by the previous request's response_metadata. This parameter is optional, but pagination is mandatory: the default value simply fetches the first "page" of the collection. See pagination for more details.
`Limit`	The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached.
`Response Type`	The response format expected from the API (e.g. application/json).

/stars.remove

Removes a star from an item.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (4)

Option Name	Description
`Channel`	Channel to remove star from, or channel where the message to remove star from was posted (used with timestamp).
`File`	File to remove star from.
`File Comment`	File comment to remove star from.
`Timestamp`	Timestamp of the message to remove star from.

/team.accessLogs

Gets the access logs for the current team.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Before`	End of time range of logs to include in results (inclusive).
`Count`	The number of log entries to return per page.
`Page`	The page number to retrieve.
`Response Type`	The response format expected from the API (e.g. application/json).

/team.billableInfo

Gets billable users information for the current team.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`User`	A user to retrieve the billable information for. Defaults to all users.
`Response Type`	The response format expected from the API (e.g. application/json).

/team.info

Gets information about the current team.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Team`	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
`Response Type`	The response format expected from the API (e.g. application/json).

/team.integrationLogs

Gets the integration logs for the current team.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App Id`	Filter logs to this Slack app. Defaults to all logs.
`Change Type`	Filter logs with this change type. Defaults to all logs.
`Count`	The number of log entries to return per page.
`Page`	The page number to retrieve.
`Service Id`	Filter logs to this service. Defaults to all logs.
`User`	Filter logs generated by this user’s actions. Defaults to all logs.
`Response Type`	The response format expected from the API (e.g. application/json).

/team.profile.get

Retrieve a team's profile.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Visibility`	Filter by visibility.
`Response Type`	The response format expected from the API (e.g. application/json).

/usergroups.create

Create a User Group

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (5)

Option Name	Description
`Name`	A name for the User Group. Must be unique among User Groups.
`Channels`	A comma separated string of encoded channel IDs for which the User Group uses as a default.
`Description`	A short description of the User Group.
`Handle`	A mention handle. Must be unique among channels, users and User Groups.
`Include Count`	Include the number of users in each User Group.

/usergroups.disable

Disable an existing User Group

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Usergroup`	The encoded ID of the User Group to disable.
`Include Count`	Include the number of users in the User Group.

/usergroups.enable

Enable a User Group

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Usergroup`	The encoded ID of the User Group to enable.
`Include Count`	Include the number of users in the User Group.

/usergroups.list

List all User Groups for a team

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Include Users`	Include the list of users for each User Group.
`Include Count`	Include the number of users in each User Group.
`Include Disabled`	Include disabled User Groups.
`Response Type`	The response format expected from the API (e.g. application/json).

/usergroups.update

Update an existing User Group

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (6)

Option Name	Description
`Usergroup`	The encoded ID of the User Group to update.
`Handle`	A mention handle. Must be unique among channels, users and User Groups.
`Description`	A short description of the User Group.
`Channels`	A comma separated string of encoded channel IDs for which the User Group uses as a default.
`Include Count`	Include the number of users in the User Group.
`Name`	A name for the User Group. Must be unique among User Groups.

/usergroups.users.list

List all users in a User Group

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Include Disabled`	Allow results that involve disabled User Groups.
`Usergroup`	(Required) The encoded ID of the User Group to update.
`Response Type`	The response format expected from the API (e.g. application/json).

/usergroups.users.update

Update the list of users for a User Group

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Usergroup`	The encoded ID of the User Group to update.
`Users`	A comma separated string of encoded user IDs that represent the entire list of users for the User Group.
`Include Count`	Include the number of users in the User Group.

/users.conversations

List conversations the calling user may access.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`User`	Browse conversations by a specific user ID's membership. Non-public channels are restricted to those where the calling user shares membership.
`Types`	Mix and match channel types by providing a comma-separated list of any combination of public_channel, private_channel, mpim, im
`Exclude Archived`	Set to true to exclude archived channels from the list
`Limit`	The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached. Must be an integer no larger than 1000.
`Cursor`	Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request's response_metadata. Default value fetches the first "page" of the collection. See pagination for more detail.
`Response Type`	The response format expected from the API (e.g. application/json).

/users.deletePhoto

Delete the user profile photo

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/users.getPresence

Gets user presence information.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`User`	User to get presence info on. Defaults to the authed user.
`Response Type`	The response format expected from the API (e.g. application/json).

/users.identity

Get a user's identity.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/users.info

Gets information about a user.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Include Locale`	Set this to true to receive the locale for this user. Defaults to false
`User`	User to get info on
`Response Type`	The response format expected from the API (e.g. application/json).

/users.list

Lists all users in a Slack team.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Limit`	The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached. Providing no limit value will result in Slack attempting to deliver you the entire result set. If the collection is too large you may experience limit_required or HTTP 500 errors.
`Cursor`	Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request's response_metadata. Default value fetches the first "page" of the collection. See pagination for more detail.
`Include Locale`	Set this to true to receive the locale for users. Defaults to false
`Response Type`	The response format expected from the API (e.g. application/json).

/users.lookupByEmail

Find a user with an email address.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Email`	(Required) An email address belonging to a user in the workspace
`Response Type`	The response format expected from the API (e.g. application/json).

/users.profile.get

Retrieves a user's profile information.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Include Labels`	Include labels for each ID in custom profile fields
`User`	User to retrieve profile info for
`Response Type`	The response format expected from the API (e.g. application/json).

/users.profile.set

Set the profile information for a user.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (4)

Option Name	Description
`Name`	Name of a single key to set. Usable only if profile is not passed.
`Profile`	Collection of key:value pairs presented as a URL-encoded JSON hash. At most 50 fields may be set. Each field name is limited to 255 characters.
`User`	ID of user to change. This argument may only be specified by team admins on paid teams.
`Value`	Value to set a single key to. Usable only if profile is not passed.

/users.setActive

Marked a user as active. Deprecated and non-functional.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/users.setPhoto

Set the user profile photo

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (4)

Option Name	Description
`Crop W`	Width/height of crop box (always square)
`Crop X`	X coordinate of top-left corner of crop box
`Crop Y`	Y coordinate of top-left corner of crop box
`Image`	File contents via multipart/form-data.

/users.setPresence

Manually sets user presence.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Presence`	Either auto or away

/views.open

Open a view for a user.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Trigger Id`	(Required) Exchange a trigger to post to the user.
`View`	(Required) A view payload. This must be a JSON-encoded string.
`Response Type`	The response format expected from the API (e.g. application/json).

/views.publish

Publish a static view for a User.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`User Id`	(Required) id of the user you want publish a view to.
`View`	(Required) A view payload. This must be a JSON-encoded string.
`Hash`	A string that represents view state to protect against possible race conditions.
`Response Type`	The response format expected from the API (e.g. application/json).

/views.push

Push a view onto the stack of a root view.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Trigger Id`	(Required) Exchange a trigger to post to the user.
`View`	(Required) A view payload. This must be a JSON-encoded string.
`Response Type`	The response format expected from the API (e.g. application/json).

/views.update

Update an existing view.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`View Id`	A unique identifier of the view to be updated. Either view_id or external_id is required.
`External Id`	A unique identifier of the view set by the developer. Must be unique for all views on a team. Max length of 255 characters. Either view_id or external_id is required.
`View`	A view object. This must be a JSON-encoded string.
`Hash`	A string that represents view state to protect against possible race conditions.
`Response Type`	The response format expected from the API (e.g. application/json).

/workflows.stepCompleted

Indicate that an app's step in a workflow completed execution.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Workflow Step Execute Id`	(Required) Context identifier that maps to the correct workflow step execution.
`Outputs`	Key-value object of outputs from your step. Keys of this object reflect the configured key properties of your outputs array from your workflow_step object.
`Response Type`	The response format expected from the API (e.g. application/json).

/workflows.stepFailed

Indicate that an app's step in a workflow failed to execute.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Workflow Step Execute Id`	(Required) Context identifier that maps to the correct workflow step execution.
`Error`	(Required) A JSON-based object with a message property that should contain a human readable error message.
`Response Type`	The response format expected from the API (e.g. application/json).

/workflows.updateStep

Update the configuration for a workflow extension step.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Workflow Step Edit Id`	(Required) A context identifier provided with view_submission payloads used to call back to workflows.updateStep.
`Inputs`	A JSON key-value map of inputs required from a user during configuration. This is the data your app expects to receive when the workflow step starts. Please note: the embedded variable format is set and replaced by the workflow system. You cannot create custom variables that will be replaced at runtime. Read more about variables in workflow steps here.
`Outputs`	An JSON array of output objects used during step execution. This is the data your app agrees to provide when your workflow step was executed.
`Step Name`	An optional field that can be used to override the step name that is shown in the Workflow Builder.
`Step Image Url`	An optional field that can be used to override app image that is shown in the Workflow Builder.
`Response Type`	The response format expected from the API (e.g. application/json).

Admin API (56)

Download

Web API (118)