You must enable javascript in order to use the Slack API Documentation. You can do this in your browser settings.
Go to Slack

API Methods

Developer preview

Welcome to the workspace token-based Slack app developer preview, still under active development.

All API methods follow the same calling conventions.

These methods specifically require workspace tokens.

api

Method Description
api.test Checks API calling code.

apps.permissions

Method Description
apps.permissions.info Returns list of permissions this app has on a team.
apps.permissions.request Allows an app to request additional scopes

auth

Method Description
auth.revoke Revokes a token.
auth.test Checks authentication & identity.

bots

Method Description
bots.info Gets information about a bot user.

channels

Get info on your team's Slack channels, create or archive channels, invite users, set the topic and purpose, and mark a channel as read.

Method Description
channels.archive Archives a channel.
channels.create Creates a channel.
channels.history Fetches history of messages and events from a channel.
channels.info Gets information about a channel.
channels.invite Invites a user to a channel.
channels.kick Removes a user from a channel.
channels.list Lists all channels in a Slack team.
channels.rename Renames a channel.
channels.replies Retrieve a thread of messages posted to a channel
channels.setPurpose Sets the purpose for a channel.
channels.setTopic Sets the topic for a channel.
channels.unarchive Unarchives a channel.

chat

Post chat messages to Slack.

Method Description
chat.delete Deletes a message.
chat.postEphemeral Sends an ephemeral message to a user in a channel.
chat.postMessage Sends a message to a channel.
chat.unfurl Provide custom unfurl behavior for user-posted URLs
chat.update Updates a message.

dialog

Method Description
dialog.open Open a dialog with a user

emoji

Method Description
emoji.list Lists custom emoji for a team.

files.comments

Method Description
files.comments.add Add a comment to an existing file.
files.comments.delete Deletes an existing comment on a file.
files.comments.edit Edit an existing file comment.

files

Get info on files uploaded to Slack, upload new files to Slack.

Method Description
files.delete Deletes a file.
files.info Gets information about a team file.
files.list Lists & filters team files.
files.revokePublicURL Revokes public/external sharing access for a file
files.sharedPublicURL Enables a file for public/external sharing.
files.upload Uploads or creates a file.

groups

Get info on your team's private channels.

Method Description
groups.archive Archives a private channel.
groups.create Creates a private channel.
groups.createChild Clones and archives a private channel.
groups.history Fetches history of messages and events from a private channel.
groups.info Gets information about a private channel.
groups.invite Invites a user to a private channel.
groups.kick Removes a user from a private channel.
groups.list Lists private channels that the calling user has access to.
groups.rename Renames a private channel.
groups.replies Retrieve a thread of messages posted to a private channel
groups.setPurpose Sets the purpose for a private channel.
groups.setTopic Sets the topic for a private channel.
groups.unarchive Unarchives a private channel.

im

Get info on your direct messages.

Method Description
im.close Close a direct message channel.
im.history Fetches history of messages and events from direct message channel.
im.list Lists direct message channels for the calling user.
im.replies Retrieve a thread of messages posted to a direct message conversation

mpim

Get info on your multiparty direct messages.

Method Description
mpim.close Closes a multiparty direct message channel.
mpim.history Fetches history of messages and events from a multiparty direct message.
mpim.list Lists multiparty direct message channels for the calling user.
mpim.replies Retrieve a thread of messages posted to a direct message conversation from a multiparty direct message.

pins

Method Description
pins.add Pins an item to a channel.
pins.list Lists items pinned to a channel.
pins.remove Un-pins an item from a channel.

reactions

Method Description
reactions.add Adds a reaction to an item.
reactions.get Gets reactions for an item.
reactions.list Lists reactions made by a user.
reactions.remove Removes a reaction from an item.

rtm

Method Description
rtm.connect Starts a Real Time Messaging session.

Search your team's files and messages.

Method Description
search.all Searches for messages and files matching a query.
search.files Searches for files matching a query.
search.messages Searches for messages matching a query.

stars

Method Description
stars.add Adds a star to an item.
stars.list Lists stars for a user.
stars.remove Removes a star from an item.

team

Method Description
team.billableInfo Gets billable users information for the current team.
team.info Gets information about the current team.
team.integrationLogs Gets the integration logs for the current team.

team.profile

Method Description
team.profile.get Retrieve a team's profile.

usergroups

Get info on your team's User Groups.

Method Description
usergroups.create Create a User Group
usergroups.disable Disable an existing User Group
usergroups.enable Enable a User Group
usergroups.list List all User Groups for a team
usergroups.update Update an existing User Group

usergroups.users

Method Description
usergroups.users.list List all users in a User Group
usergroups.users.update Update the list of users for a User Group

users

Get info on members of your Slack team.

Method Description
users.identity Get a user's identity.
users.info Gets information about a user.
users.list Lists all users in a Slack team.

users.profile

Method Description
users.profile.get Retrieves a user's profile information.

The Web API has an OpenAPI 2.0 specification. Follow changes to the Web API with our changelog and on GitHub.