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.approved

MethodDescription
admin.apps.approved.listList approved apps for an org or workspace.

admin.apps.requests

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

admin.apps.restricted

MethodDescription
admin.apps.restricted.listList restricted apps for an org or workspace.

admin.conversations

MethodDescription
admin.conversations.archiveArchive a public or private channel.
admin.conversations.convertToPrivateConvert a public channel to a private channel.
admin.conversations.createCreate a public or private channel-based conversation.
admin.conversations.deleteDelete a public or private channel.
admin.conversations.disconnectSharedDisconnect a connected channel from one or more workspaces.
admin.conversations.getConversationPrefsGet conversation preferences for a public or private channel.
admin.conversations.getTeamsGet all the workspaces a given public or private channel is connected to within this Enterprise org.
admin.conversations.inviteInvite a user to a public or private channel.
admin.conversations.renameRename a public or private channel.
admin.conversations.searchSearch for public or private channels in an Enterprise organization.
admin.conversations.setConversationPrefsSet the posting permissions for a public or private channel.
admin.conversations.setTeamsSet the workspaces in an Enterprise grid org that connect to a public or private channel.
admin.conversations.unarchiveUnarchive a public or private channel.

admin.conversations.ekm

MethodDescription
admin.conversations.ekm.listOriginalConnectedChannelInfoList 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.

admin.conversations.restrictAccess

Add and remove user groups from conversations.

MethodDescription
admin.conversations.restrictAccess.addGroupAdd an allowlist of IDP groups for accessing a channel
admin.conversations.restrictAccess.listGroupsList all IDP Groups linked to a channel
admin.conversations.restrictAccess.removeGroupRemove a linked IDP group linked from a private channel

admin.emoji

MethodDescription
admin.emoji.addAdd an emoji.
admin.emoji.addAliasAdd an emoji alias.
admin.emoji.listList emoji for an Enterprise Grid organization.
admin.emoji.removeRemove an emoji across an Enterprise Grid organization
admin.emoji.renameRename an emoji.

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.infoFetch information about settings in a workspace
admin.teams.settings.setDefaultChannelsSet the default channels of a workspace.
admin.teams.settings.setDescriptionSet the description of a given workspace.
admin.teams.settings.setDiscoverabilityAn API method that allows admins to set the discoverability of a given workspace
admin.teams.settings.setIconSets the icon of a workspace.
admin.teams.settings.setNameSet the name of a given workspace.

admin.usergroups

MethodDescription
admin.usergroups.addChannelsAdd one or more default channels to an IDP group.
admin.usergroups.addTeamsAssociate one or more default workspaces with an organization-wide IDP group.
admin.usergroups.listChannelsList the channels linked to an org-level IDP group (user group).
admin.usergroups.removeChannelsRemove one or more default channels from an org-level IDP group (user group).

admin.users

MethodDescription
admin.users.assignAdd an Enterprise user to a workspace.
admin.users.inviteInvite a user to a workspace.
admin.users.listList users on 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.setExpirationSet an expiration for a guest 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.invalidateRevoke a single session for a user. The user will be forced to login to Slack.
admin.users.session.listLists all active user sessions for an organization
admin.users.session.resetWipes all valid sessions on all devices for a given user

api

MethodDescription
api.testChecks API calling code.

apps.event.authorizations

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

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.

calls

MethodDescription
calls.addRegisters a new Call.
calls.endEnds a Call.
calls.infoReturns information about a Call.
calls.updateUpdates information about a Call.

calls.participants

MethodDescription
calls.participants.addRegisters new participants added to a Call.
calls.participants.removeRegisters participants removed from a Call.

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.markSets the read cursor in a channel.
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 file.
files.listList for a team, in a channel, or from a user with applied filters.
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.

migration

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

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.getRetrieve a user's profile information, including their custom status.
users.profile.setSet a user's profile information, including custom status.

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.

workflows

MethodDescription
workflows.stepCompletedIndicate that an app's step in a workflow completed execution.
workflows.stepFailedIndicate that an app's step in a workflow failed to execute.
workflows.updateStepUpdate the configuration for a workflow extension step.

Deprecated: admin.conversations.whitelist

Add and remove user groups from conversations. Use admin.conversations.* equivalents instead.

MethodDescription
admin.conversations.whitelist.addDeprecated. Add an allowlist of IDP groups for accessing a channel
admin.conversations.whitelist.listGroupsLinkedToChannelDeprecated. List all IDP Groups linked to a channel
admin.conversations.whitelist.removeDeprecated. Remove an allowlisted IDP group linked to a private channel

Deprecated: 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.archiveDeprecated. Archives a channel.
channels.createDeprecated. Creates a channel.
channels.historyDeprecated. Fetches history of messages and events from a channel.
channels.infoDeprecated. Gets information about a channel.
channels.inviteDeprecated. Invites a user to a channel.
channels.joinDeprecated. Joins a channel, creating it if needed.
channels.kickDeprecated. Removes a user from a channel.
channels.leaveDeprecated. Leaves a channel.
channels.listDeprecated. Lists all channels in a Slack team.
channels.markDeprecated. Sets the read cursor in a channel.
channels.renameDeprecated. Renames a channel.
channels.repliesDeprecated. Retrieve a thread of messages posted to a channel
channels.setPurposeDeprecated. Sets the purpose for a channel.
channels.setTopicDeprecated. Sets the topic for a channel.
channels.unarchiveDeprecated. Unarchives a channel.

Deprecated: groups

Get info on your team's private channels.

MethodDescription
groups.archiveDeprecated. Archives a private channel.
groups.createDeprecated. Creates a private channel.
groups.createChildDeprecated. Clones and archives a private channel.
groups.historyDeprecated. Fetches history of messages and events from a private channel.
groups.infoDeprecated. Gets information about a private channel.
groups.inviteDeprecated. Invites a user to a private channel.
groups.kickDeprecated. Removes a user from a private channel.
groups.leaveDeprecated. Leaves a private channel.
groups.listDeprecated. Lists private channels that the calling user has access to.
groups.markDeprecated. Sets the read cursor in a private channel.
groups.openDeprecated. Opens a private channel.
groups.renameDeprecated. Renames a private channel.
groups.repliesDeprecated. Retrieve a thread of messages posted to a private channel
groups.setPurposeDeprecated. Sets the purpose for a private channel.
groups.setTopicDeprecated. Sets the topic for a private channel.
groups.unarchiveDeprecated. Unarchives a private channel.

Deprecated: im

Get info on your direct messages.

MethodDescription
im.closeDeprecated. Close a direct message channel.
im.historyDeprecated. Fetches history of messages and events from direct message channel.
im.listDeprecated. Lists direct message channels for the calling user.
im.markDeprecated. Sets the read cursor in a direct message channel.
im.openDeprecated. Opens a direct message channel.
im.repliesDeprecated. Retrieve a thread of messages posted to a direct message conversation

Deprecated: mpim

Get info on your multiparty direct messages.

MethodDescription
mpim.closeDeprecated. Closes a multiparty direct message channel.
mpim.historyDeprecated. Fetches history of messages and events from a multiparty direct message.
mpim.listDeprecated. Lists multiparty direct message channels for the calling user.
mpim.markDeprecated. Sets the read cursor in a multiparty direct message channel.
mpim.openDeprecated. This method opens a multiparty direct message.
mpim.repliesDeprecated. Retrieve a thread of messages posted to a direct message conversation from a multiparty direct message.

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