Go to Slack

API Methods

Developer preview has ended

The developer preview for workspace apps has ended. We’re taking the components of workspace apps and bringing them in phases to existing as well as new apps.

You are welcome to install workspace apps as internal integrations or distribute them to other workspaces, but we won't accept them as submissions for the Slack app directory going forward.

All API methods follow the same calling conventions.

These methods specifically require workspace tokens.

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.

chat

Post chat messages to Slack.

MethodDescription
chat.deleteDeletes a message.
chat.getPermalinkRetrieve a permalink URL for a specific extant message
chat.postEphemeralSends an ephemeral message to a user in a channel.
chat.postMessageSends a message to a channel.
chat.unfurlProvide custom unfurl behavior for user-posted URLs
chat.updateUpdates a message.

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.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.listLists all channels in a Slack team.
conversations.membersRetrieve members of a conversation.
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.

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.

stars

MethodDescription
stars.listLists stars for a user.

team

MethodDescription
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.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.profile

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

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