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

API Methods

All API methods follow the same calling conventions.

admin.apps

MethodDescription
admin.apps.approveApprove an app for installation on a workspace.
admin.apps.restrictRestrict an app for installation on a workspace.

admin.apps.requests

MethodDescription
admin.apps.requests.listList app requests for a team/workspace.

admin.inviteRequests

MethodDescription
admin.inviteRequests.approveApprove a workspace invite request.
admin.inviteRequests.denyDeny a workspace invite request.
admin.inviteRequests.listList all pending workspace invite requests.

admin.inviteRequests.approved

MethodDescription
admin.inviteRequests.approved.listList all approved workspace invite requests.

admin.inviteRequests.denied

MethodDescription
admin.inviteRequests.denied.listList all denied workspace invite requests.

admin.teams.admins

MethodDescription
admin.teams.admins.listList all of the admins on a given workspace.

admin.teams

MethodDescription
admin.teams.createCreate an Enterprise team.
admin.teams.listList all teams on an Enterprise organization

admin.teams.owners

MethodDescription
admin.teams.owners.listList all of the owners on a given workspace.

admin.teams.settings

MethodDescription
admin.teams.settings.setDescriptionSet the description of a given workspace.
admin.teams.settings.setIconSets the icon of a workspace.
admin.teams.settings.setNameSet the name of a given workspace.

admin.users

MethodDescription
admin.users.assignAdd an Enterprise user to a workspace.
admin.users.inviteInvite a user to a workspace.
admin.users.removeRemove a user from a workspace.
admin.users.setAdminSet an existing guest, regular user, or owner to be an admin user.
admin.users.setOwnerSet an existing guest, regular user, or admin user to be a workspace owner.
admin.users.setRegularSet an existing guest user, admin user, or owner to be a regular user.

admin.users.session

MethodDescription
admin.users.session.resetWipes all valid sessions on all devices for a given user

api

MethodDescription
api.testChecks API calling code.

apps.permissions

MethodDescription
apps.permissions.infoReturns list of permissions this app has on a team.
apps.permissions.requestAllows an app to request additional scopes

apps.permissions.resources

MethodDescription
apps.permissions.resources.listReturns list of resource grants this app has on a team.

apps.permissions.scopes

MethodDescription
apps.permissions.scopes.listReturns list of scopes this app has on a team.

apps.permissions.users

MethodDescription
apps.permissions.users.listReturns list of user grants and corresponding scopes this app has on a team.
apps.permissions.users.requestEnables an app to trigger a permissions modal to grant an app access to a user access scope.

apps

MethodDescription
apps.uninstallUninstalls your app from a workspace.

auth

MethodDescription
auth.revokeRevokes a token.
auth.testChecks authentication & identity.

bots

MethodDescription
bots.infoGets 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.

MethodDescription
channels.archiveArchives a channel.
channels.createCreates a channel.
channels.historyFetches history of messages and events from a channel.
channels.infoGets information about a channel.
channels.inviteInvites a user to a channel.
channels.joinJoins a channel, creating it if needed.
channels.kickRemoves a user from a channel.
channels.leaveLeaves a channel.
channels.listLists all channels in a Slack team.
channels.markSets the read cursor in a channel.
channels.renameRenames a channel.
channels.repliesRetrieve a thread of messages posted to a channel
channels.setPurposeSets the purpose for a channel.
channels.setTopicSets the topic for a channel.
channels.unarchiveUnarchives a channel.

chat

Post chat messages to Slack.

MethodDescription
chat.deleteDeletes a message.
chat.deleteScheduledMessageDeletes a pending scheduled message from the queue.
chat.getPermalinkRetrieve a permalink URL for a specific extant message
chat.meMessageShare a me message into a channel.
chat.postEphemeralSends an ephemeral message to a user in a channel.
chat.postMessageSends a message to a channel.
chat.scheduleMessageSchedules a message to be sent to a channel.
chat.unfurlProvide custom unfurl behavior for user-posted URLs
chat.updateUpdates a message.

chat.scheduledMessages

MethodDescription
chat.scheduledMessages.listReturns a list of scheduled messages.

conversations

Interface with all kinds of conversations the same way, whether they're public or private channels, direct messages, or otherwise.

MethodDescription
conversations.archiveArchives a conversation.
conversations.closeCloses a direct message or multi-person direct message.
conversations.createInitiates a public or private channel-based conversation
conversations.historyFetches a conversation's history of messages and events.
conversations.infoRetrieve information about a conversation.
conversations.inviteInvites users to a channel.
conversations.joinJoins an existing conversation.
conversations.kickRemoves a user from a conversation.
conversations.leaveLeaves a conversation.
conversations.listLists all channels in a Slack team.
conversations.membersRetrieve members of a conversation.
conversations.openOpens or resumes a direct message or multi-person direct message.
conversations.renameRenames a conversation.
conversations.repliesRetrieve a thread of messages posted to a conversation
conversations.setPurposeSets the purpose for a conversation.
conversations.setTopicSets the topic for a conversation.
conversations.unarchiveReverses conversation archival.

dialog

MethodDescription
dialog.openOpen a dialog with a user

dnd

Adjust and view Do Not Disturb settings for team members.

MethodDescription
dnd.endDndEnds the current user's Do Not Disturb session immediately.
dnd.endSnoozeEnds the current user's snooze mode immediately.
dnd.infoRetrieves a user's current Do Not Disturb status.
dnd.setSnoozeTurns on Do Not Disturb mode for the current user, or changes its duration.
dnd.teamInfoRetrieves the Do Not Disturb status for up to 50 users on a team.

emoji

MethodDescription
emoji.listLists custom emoji for a team.

files.comments

MethodDescription
files.comments.deleteDeletes an existing comment on a file.

files

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

MethodDescription
files.deleteDeletes a file.
files.infoGets information about a team file.
files.listLists & filters team files.
files.revokePublicURLRevokes public/external sharing access for a file
files.sharedPublicURLEnables a file for public/external sharing.
files.uploadUploads or creates a file.

files.remote

MethodDescription
files.remote.addAdds a file from a remote service
files.remote.infoRetrieve information about a remote file added to Slack
files.remote.listRetrieve information about a remote file added to Slack
files.remote.removeRemove a remote file.
files.remote.shareShare a remote file into a channel.
files.remote.updateUpdates an existing remote file.

groups

Get info on your team's private channels.

MethodDescription
groups.archiveArchives a private channel.
groups.createCreates a private channel.
groups.createChildClones and archives a private channel.
groups.historyFetches history of messages and events from a private channel.
groups.infoGets information about a private channel.
groups.inviteInvites a user to a private channel.
groups.kickRemoves a user from a private channel.
groups.leaveLeaves a private channel.
groups.listLists private channels that the calling user has access to.
groups.markSets the read cursor in a private channel.
groups.openOpens a private channel.
groups.renameRenames a private channel.
groups.repliesRetrieve a thread of messages posted to a private channel
groups.setPurposeSets the purpose for a private channel.
groups.setTopicSets the topic for a private channel.
groups.unarchiveUnarchives a private channel.

im

Get info on your direct messages.

MethodDescription
im.closeClose a direct message channel.
im.historyFetches history of messages and events from direct message channel.
im.listLists direct message channels for the calling user.
im.markSets the read cursor in a direct message channel.
im.openOpens a direct message channel.
im.repliesRetrieve a thread of messages posted to a direct message conversation

migration

MethodDescription
migration.exchangeFor Enterprise Grid workspaces, map local user IDs to global user IDs

mpim

Get info on your multiparty direct messages.

MethodDescription
mpim.closeCloses a multiparty direct message channel.
mpim.historyFetches history of messages and events from a multiparty direct message.
mpim.listLists multiparty direct message channels for the calling user.
mpim.markSets the read cursor in a multiparty direct message channel.
mpim.openThis method opens a multiparty direct message.
mpim.repliesRetrieve a thread of messages posted to a direct message conversation from a multiparty direct message.

oauth

MethodDescription
oauth.accessExchanges a temporary OAuth verifier code for an access token.
oauth.tokenExchanges a temporary OAuth verifier code for a workspace token.

oauth.v2

MethodDescription
oauth.v2.accessExchanges a temporary OAuth verifier code for an access token.

pins

MethodDescription
pins.addPins an item to a channel.
pins.listLists items pinned to a channel.
pins.removeUn-pins an item from a channel.

reactions

MethodDescription
reactions.addAdds a reaction to an item.
reactions.getGets reactions for an item.
reactions.listLists reactions made by a user.
reactions.removeRemoves a reaction from an item.

reminders

MethodDescription
reminders.addCreates a reminder.
reminders.completeMarks a reminder as complete.
reminders.deleteDeletes a reminder.
reminders.infoGets information about a reminder.
reminders.listLists all reminders created by or for a given user.

rtm

MethodDescription
rtm.connectStarts a Real Time Messaging session.
rtm.startStarts a Real Time Messaging session.

Search your team's files and messages.

MethodDescription
search.allSearches for messages and files matching a query.
search.filesSearches for files matching a query.
search.messagesSearches for messages matching a query.

stars

MethodDescription
stars.addAdds a star to an item.
stars.listLists stars for a user.
stars.removeRemoves a star from an item.

team

MethodDescription
team.accessLogsGets the access logs for the current team.
team.billableInfoGets billable users information for the current team.
team.infoGets information about the current team.
team.integrationLogsGets the integration logs for the current team.

team.profile

MethodDescription
team.profile.getRetrieve a team's profile.

usergroups

Get info on your team's User Groups.

MethodDescription
usergroups.createCreate a User Group
usergroups.disableDisable an existing User Group
usergroups.enableEnable a User Group
usergroups.listList all User Groups for a team
usergroups.updateUpdate an existing User Group

usergroups.users

MethodDescription
usergroups.users.listList all users in a User Group
usergroups.users.updateUpdate the list of users for a User Group

users

Get info on members of your Slack team.

MethodDescription
users.conversationsList conversations the calling user may access.
users.deletePhotoDelete the user profile photo
users.getPresenceGets user presence information.
users.identityGet a user's identity.
users.infoGets information about a user.
users.listLists all users in a Slack team.
users.lookupByEmailFind a user with an email address.
users.setActiveMarked a user as active. Deprecated and non-functional.
users.setPhotoSet the user profile photo
users.setPresenceManually sets user presence.

users.profile

MethodDescription
users.profile.getRetrieves a user's profile information.
users.profile.setSet the profile information for a user.

views

MethodDescription
views.openOpen a view for a user.
views.publishPublish a static view for a User.
views.pushPush a view onto the stack of a root view.
views.updateUpdate an existing view.

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