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.
| 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 |
|---|---|
| apps.uninstall | Uninstalls your app from a workspace. |
| Method | Description |
|---|---|
| auth.revoke | Revokes a token. |
| auth.test | Checks authentication & identity. |
| Method | Description |
|---|---|
| bots.info | Gets information about a bot user. |
Post chat messages to Slack.
| Method | Description |
|---|---|
| chat.delete | Deletes a message. |
| chat.getPermalink | Retrieve a permalink URL for a specific extant message |
| 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.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.list | Lists all channels in a Slack team. |
| conversations.members | Retrieve members of a conversation. |
| 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. |
Get info on files uploaded to Slack, upload new files to Slack.
| Method | Description |
|---|---|
| files.info | Gets information about a team file. |
| files.list | Lists & filters team files. |
| 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 |
|---|---|
| stars.list | Lists stars for a user. |
| Method | Description |
|---|---|
| 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.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. |
| 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.