All API methods follow the same calling conventions.
| Method | Description |
|---|---|
| api.test | Checks API calling code. |
| 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 |
| Method | Description |
|---|---|
| apps.permissions.resources.list | Returns list of resource grants this app has on a team. |
| Method | Description |
|---|---|
| apps.permissions.scopes.list | Returns list of scopes this app has on a team. |
| 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. |
| Method | Description |
|---|---|
| auth.revoke | Revokes a token. |
| auth.test | Checks authentication & identity. |
| Method | Description |
|---|---|
| bots.info | Gets information about a bot user. |
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. |
Post chat messages to Slack.
| Method | Description |
|---|---|
| chat.delete | Deletes a message. |
| 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.unfurl | Provide custom unfurl behavior for user-posted URLs |
| chat.update | Updates a message. |
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. |
| Method | Description |
|---|---|
| dialog.open | Open a dialog with a user |
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 users on a team. |
| Method | Description |
|---|---|
| emoji.list | Lists custom emoji for a team. |
| 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. |
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. |
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. |
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 |
| Method | Description |
|---|---|
| migration.exchange | For Enterprise Grid workspaces, map local user IDs to global user IDs |
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. |
| 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. |
| 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. |
| 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. |
| 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. |
| Method | Description |
|---|---|
| rtm.connect | Starts a Real Time Messaging session. |
| rtm.start | 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. |
| 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. |
| 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. |
| Method | Description |
|---|---|
| team.profile.get | Retrieve a team's profile. |
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 |
| Method | Description |
|---|---|
| usergroups.users.list | List all users in a User Group |
| usergroups.users.update | Update the list of users for a User Group |
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. |
| 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.