API Methods

All methods Methods for workspace tokens

All API methods follow the same calling conventions.

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

apps.permissions.resources

Method	Description
apps.permissions.resources.list	Returns list of resource grants this app has on a team.

apps.permissions.scopes

Method	Description
apps.permissions.scopes.list	Returns list of scopes this app has on a team.

apps.permissions.users

Method	Description
apps.permissions.users.list	Returns list of user grants and corresponding scopes this app has on a team.
apps.permissions.users.request	Enables an app to trigger a permissions modal to grant an app access to a user access scope.

apps

Method	Description
apps.uninstall	Uninstalls your app from a workspace.

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.join	Joins a channel, creating it if needed.
channels.kick	Removes a user from a channel.
channels.leave	Leaves a channel.
channels.list	Lists all channels in a Slack team.
channels.mark	Sets the read cursor in a channel.
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.deleteScheduledMessage	Deletes a pending scheduled message from the queue.
chat.getPermalink	Retrieve a permalink URL for a specific extant message
chat.meMessage	Share a me message into a channel.
chat.postEphemeral	Sends an ephemeral message to a user in a channel.
chat.postMessage	Sends a message to a channel.
chat.scheduleMessage	Schedules a message to be sent to a channel.
chat.unfurl	Provide custom unfurl behavior for user-posted URLs
chat.update	Updates a message.

chat.scheduledMessages

Method	Description
chat.scheduledMessages.list	Returns 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.

Method	Description
conversations.archive	Archives a conversation.
conversations.close	Closes a direct message or multi-person direct message.
conversations.create	Initiates a public or private channel-based conversation
conversations.history	Fetches a conversation's history of messages and events.
conversations.info	Retrieve information about a conversation.
conversations.invite	Invites users to a channel.
conversations.join	Joins an existing conversation.
conversations.kick	Removes a user from a conversation.
conversations.leave	Leaves a conversation.
conversations.list	Lists all channels in a Slack team.
conversations.members	Retrieve members of a conversation.
conversations.open	Opens or resumes a direct message or multi-person direct message.
conversations.rename	Renames a conversation.
conversations.replies	Retrieve a thread of messages posted to a conversation
conversations.setPurpose	Sets the purpose for a conversation.
conversations.setTopic	Sets the topic for a conversation.
conversations.unarchive	Reverses conversation archival.

dialog

Method	Description
dialog.open	Open a dialog with a user

dnd

Adjust and view Do Not Disturb settings for team members.

Method	Description
dnd.endDnd	Ends the current user's Do Not Disturb session immediately.
dnd.endSnooze	Ends the current user's snooze mode immediately.
dnd.info	Retrieves a user's current Do Not Disturb status.
dnd.setSnooze	Turns on Do Not Disturb mode for the current user, or changes its duration.
dnd.teamInfo	Retrieves the Do Not Disturb status for up to 50 users on a team.

emoji

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

files.comments

Method	Description
files.comments.delete	Deletes an existing comment on a file.

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.leave	Leaves a private channel.
groups.list	Lists private channels that the calling user has access to.
groups.mark	Sets the read cursor in a private channel.
groups.open	Opens a private channel.
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.mark	Sets the read cursor in a direct message channel.
im.open	Opens a direct message channel.
im.replies	Retrieve a thread of messages posted to a direct message conversation

migration

Method	Description
migration.exchange	For Enterprise Grid workspaces, map local user IDs to global user IDs

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.mark	Sets the read cursor in a multiparty direct message channel.
mpim.open	This method opens a multiparty direct message.
mpim.replies	Retrieve a thread of messages posted to a direct message conversation from a multiparty direct message.

oauth

Method	Description
oauth.access	Exchanges a temporary OAuth verifier code for an access token.
oauth.token	Exchanges a temporary OAuth verifier code for a workspace token.

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.

reminders

Method	Description
reminders.add	Creates a reminder.
reminders.complete	Marks a reminder as complete.
reminders.delete	Deletes a reminder.
reminders.info	Gets information about a reminder.
reminders.list	Lists all reminders created by or for a given user.

rtm

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

search

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.accessLogs	Gets the access logs for the current team.
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.conversations	List conversations the calling user may access.
users.deletePhoto	Delete the user profile photo
users.getPresence	Gets user presence information.
users.identity	Get a user's identity.
users.info	Gets information about a user.
users.list	Lists all users in a Slack team.
users.lookupByEmail	Find a user with an email address.
users.setActive	Marked a user as active. Deprecated and non-functional.
users.setPhoto	Set the user profile photo
users.setPresence	Manually sets user presence.

users.profile

Method	Description
users.profile.get	Retrieves a user's profile information.
users.profile.set	Set 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.