API Methods
All API methods follow the same calling conventions.
admin.analytics
Method | Description |
---|---|
admin.analytics.getFile | Retrieve analytics data for a given date, presented as a compressed JSON file |
admin.apps
Method | Description |
---|---|
admin.apps.approve | Approve an app for installation on a workspace. |
admin.apps.clearResolution | Clear an app resolution |
admin.apps.restrict | Restrict an app for installation on a workspace. |
admin.apps.approved
Method | Description |
---|---|
admin.apps.approved.list | List approved apps for an org or workspace. |
admin.apps.requests
Method | Description |
---|---|
admin.apps.requests.list | List app requests for a team/workspace. |
admin.apps.restricted
Method | Description |
---|---|
admin.apps.restricted.list | List restricted apps for an org or workspace. |
admin.barriers
Method | Description |
---|---|
admin.barriers.create | Create an Information Barrier |
admin.barriers.delete | Delete an existing Information Barrier |
admin.barriers.list | Get all Information Barriers for your organization |
admin.barriers.update | Update an existing Information Barrier |
admin.conversations
Method | Description |
---|---|
admin.conversations.archive | Archive a public or private channel. |
admin.conversations.convertToPrivate | Convert a public channel to a private channel. |
admin.conversations.create | Create a public or private channel-based conversation. |
admin.conversations.delete | Delete a public or private channel. |
admin.conversations.getConversationPrefs | Get conversation preferences for a public or private channel. |
admin.conversations.getCustomRetention | This API endpoint can be used by any admin to get a channel's retention policy. |
admin.conversations.getTeams | Get all the workspaces a given public or private channel is connected to within this Enterprise org. |
admin.conversations.invite | Invite a user to a public or private channel. |
admin.conversations.removeCustomRetention | This API endpoint can be used by any admin to remove a channel's retention policy. |
admin.conversations.rename | Rename a public or private channel. |
admin.conversations.search | Search for public or private channels in an Enterprise organization. |
admin.conversations.setConversationPrefs | Set the posting permissions for a public or private channel. |
admin.conversations.setCustomRetention | This API endpoint can be used by any admin to set a channel's retention policy. |
admin.conversations.setTeams | Set the workspaces in an Enterprise grid org that connect to a public or private channel. |
admin.conversations.unarchive | Unarchive a public or private channel. |
admin.conversations.ekm
Method | Description |
---|---|
admin.conversations.ekm.listOriginalConnectedChannelInfo | List 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.
Method | Description |
---|---|
admin.conversations.restrictAccess.addGroup | Add an allowlist of IDP groups for accessing a channel |
admin.conversations.restrictAccess.listGroups | List all IDP Groups linked to a channel |
admin.conversations.restrictAccess.removeGroup | Remove a linked IDP group linked from a private channel |
admin.emoji
Method | Description |
---|---|
admin.emoji.add | Add an emoji. |
admin.emoji.addAlias | Add an emoji alias. |
admin.emoji.list | List emoji for an Enterprise Grid organization. |
admin.emoji.remove | Remove an emoji across an Enterprise Grid organization |
admin.emoji.rename | Rename an emoji. |
admin.inviteRequests
Method | Description |
---|---|
admin.inviteRequests.approve | Approve a workspace invite request. |
admin.inviteRequests.deny | Deny a workspace invite request. |
admin.inviteRequests.list | List all pending workspace invite requests. |
admin.inviteRequests.approved
Method | Description |
---|---|
admin.inviteRequests.approved.list | List all approved workspace invite requests. |
admin.inviteRequests.denied
Method | Description |
---|---|
admin.inviteRequests.denied.list | List all denied workspace invite requests. |
admin.teams.admins
Method | Description |
---|---|
admin.teams.admins.list | List all of the admins on a given workspace. |
admin.teams
Method | Description |
---|---|
admin.teams.create | Create an Enterprise team. |
admin.teams.list | List all teams on an Enterprise organization |
admin.teams.owners
Method | Description |
---|---|
admin.teams.owners.list | List all of the owners on a given workspace. |
admin.teams.settings
Method | Description |
---|---|
admin.teams.settings.info | Fetch information about settings in a workspace |
admin.teams.settings.setDefaultChannels | Set the default channels of a workspace. |
admin.teams.settings.setDescription | Set the description of a given workspace. |
admin.teams.settings.setDiscoverability | An API method that allows admins to set the discoverability of a given workspace |
admin.teams.settings.setIcon | Sets the icon of a workspace. |
admin.teams.settings.setName | Set the name of a given workspace. |
admin.usergroups
Method | Description |
---|---|
admin.usergroups.addChannels | Add up to one hundred default channels to an IDP group. |
admin.usergroups.addTeams | Associate one or more default workspaces with an organization-wide IDP group. |
admin.usergroups.listChannels | List the channels linked to an org-level IDP group (user group). |
admin.usergroups.removeChannels | Remove one or more default channels from an org-level IDP group (user group). |
admin.users
Method | Description |
---|---|
admin.users.assign | Add an Enterprise user to a workspace. |
admin.users.invite | Invite a user to a workspace. |
admin.users.list | List users on a workspace |
admin.users.remove | Remove a user from a workspace. |
admin.users.setAdmin | Set an existing guest, regular user, or owner to be an admin user. |
admin.users.setExpiration | Set an expiration for a guest user |
admin.users.setOwner | Set an existing guest, regular user, or admin user to be a workspace owner. |
admin.users.setRegular | Set an existing guest user, admin user, or owner to be a regular user. |
admin.users.session
Method | Description |
---|---|
admin.users.session.clearSettings | Clear user-specific session settings—the session duration and what happens when the client closes—for a list of users. |
admin.users.session.getSettings | Get user-specific session settings—the session duration and what happens when the client closes—given a list of users. |
admin.users.session.invalidate | Revoke a single session for a user. The user will be forced to login to Slack. |
admin.users.session.list | List active user sessions for an organization |
admin.users.session.reset | Wipes all valid sessions on all devices for a given user |
admin.users.session.setSettings | Configure the user-level session settings—the session duration and what happens when the client closes—for one or more users. |
api
Method | Description |
---|---|
api.test | Checks API calling code. |
apps.connections
Method | Description |
---|---|
apps.connections.open | Generate a temporary Socket Mode WebSocket URL that your app can connect to in order to receive events and interactive payloads over, |
apps.event.authorizations
Method | Description |
---|---|
apps.event.authorizations.list | Get a list of authorizations for the given event context. Each authorization represents an app installation that the event is visible to. |
apps
Method | Description |
---|---|
apps.uninstall | Uninstalls your app from a workspace. |
auth
Method | Description |
---|---|
auth.revoke | Revokes a token. |
auth.test | Checks authentication & identity. |
auth.teams
Method | Description |
---|---|
auth.teams.list | List the workspaces a token can access. |
bots
Method | Description |
---|---|
bots.info | Gets information about a bot user. |
calls
Method | Description |
---|---|
calls.add | Registers a new Call. |
calls.end | Ends a Call. |
calls.info | Returns information about a Call. |
calls.update | Updates information about a Call. |
calls.participants
Method | Description |
---|---|
calls.participants.add | Registers new participants added to a Call. |
calls.participants.remove | Registers participants removed from a Call. |
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.mark | Sets the read cursor in a channel. |
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 file. |
files.list | List for a team, in a channel, or from a user with applied filters. |
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. |
files.remote
Method | Description |
---|---|
files.remote.add | Adds a file from a remote service |
files.remote.info | Retrieve information about a remote file added to Slack |
files.remote.list | Retrieve information about a remote file added to Slack |
files.remote.remove | Remove a remote file. |
files.remote.share | Share a remote file into a channel. |
files.remote.update | Updates an existing remote file. |
migration
Method | Description |
---|---|
migration.exchange | For Enterprise Grid workspaces, map local user IDs to global user IDs |
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. |
oauth.v2
Method | Description |
---|---|
oauth.v2.access | Exchanges a temporary OAuth verifier code for an access 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 | Retrieve a user's profile information, including their custom status. |
users.profile.set | Set a user's profile information, including custom status. |
views
Method | Description |
---|---|
views.open | Open a view for a user. |
views.publish | Publish a static view for a User. |
views.push | Push a view onto the stack of a root view. |
views.update | Update an existing view. |
workflows
Method | Description |
---|---|
workflows.stepCompleted | Indicate that an app's step in a workflow completed execution. |
workflows.stepFailed | Indicate that an app's step in a workflow failed to execute. |
workflows.updateStep | Update the configuration for a workflow step. |
Deprecated:Â apps.permissions
Manage permissions for legacy workspace apps.
Method | Description |
---|---|
apps.permissions.info | (Deprecated) Returns list of permissions this app has on a team. |
apps.permissions.request | (Deprecated) Allows an app to request additional scopes |
Deprecated:Â apps.permissions.resources
Manage permissions for legacy workspace apps.
Method | Description |
---|---|
apps.permissions.resources.list | (Deprecated) Returns list of resource grants this app has on a team. |
Deprecated:Â apps.permissions.scopes
Manage permissions for legacy workspace apps.
Method | Description |
---|---|
apps.permissions.scopes.list | (Deprecated) Returns list of scopes this app has on a team. |
Deprecated:Â apps.permissions.users
Manage permissions for legacy workspace apps.
Method | Description |
---|---|
apps.permissions.users.list | (Deprecated) Returns list of user grants and corresponding scopes this app has on a team. |
apps.permissions.users.request | (Deprecated) Enables an app to trigger a permissions modal to grant an app access to a user access scope. |
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.
Method | Description |
---|---|
channels.archive | Deprecated. Archives a channel. |
channels.create | Deprecated. Creates a channel. |
channels.history | Deprecated. Fetches history of messages and events from a channel. |
channels.info | Deprecated. Gets information about a channel. |
channels.invite | Deprecated. Invites a user to a channel. |
channels.join | Deprecated. Joins a channel, creating it if needed. |
channels.kick | Deprecated. Removes a user from a channel. |
channels.leave | Deprecated. Leaves a channel. |
channels.list | Deprecated. Lists all channels in a Slack team. |
channels.mark | Deprecated. Sets the read cursor in a channel. |
channels.rename | Deprecated. Renames a channel. |
channels.replies | Deprecated. Retrieve a thread of messages posted to a channel |
channels.setPurpose | Deprecated. Sets the purpose for a channel. |
channels.setTopic | Deprecated. Sets the topic for a channel. |
channels.unarchive | Deprecated. Unarchives a channel. |
Deprecated:Â groups
Get info on your team's private channels.
Method | Description |
---|---|
groups.archive | Deprecated. Archives a private channel. |
groups.create | Deprecated. Creates a private channel. |
groups.createChild | Deprecated. Clones and archives a private channel. |
groups.history | Deprecated. Fetches history of messages and events from a private channel. |
groups.info | Deprecated. Gets information about a private channel. |
groups.invite | Deprecated. Invites a user to a private channel. |
groups.kick | Deprecated. Removes a user from a private channel. |
groups.leave | Deprecated. Leaves a private channel. |
groups.list | Deprecated. Lists private channels that the calling user has access to. |
groups.mark | Deprecated. Sets the read cursor in a private channel. |
groups.open | Deprecated. Opens a private channel. |
groups.rename | Deprecated. Renames a private channel. |
groups.replies | Deprecated. Retrieve a thread of messages posted to a private channel |
groups.setPurpose | Deprecated. Sets the purpose for a private channel. |
groups.setTopic | Deprecated. Sets the topic for a private channel. |
groups.unarchive | Deprecated. Unarchives a private channel. |
Deprecated:Â im
Get info on your direct messages.
Method | Description |
---|---|
im.close | Deprecated. Close a direct message channel. |
im.history | Deprecated. Fetches history of messages and events from direct message channel. |
im.list | Deprecated. Lists direct message channels for the calling user. |
im.mark | Deprecated. Sets the read cursor in a direct message channel. |
im.open | Deprecated. Opens a direct message channel. |
im.replies | Deprecated. Retrieve a thread of messages posted to a direct message conversation |
Deprecated:Â mpim
Get info on your multiparty direct messages.
Method | Description |
---|---|
mpim.close | Deprecated. Closes a multiparty direct message channel. |
mpim.history | Deprecated. Fetches history of messages and events from a multiparty direct message. |
mpim.list | Deprecated. Lists multiparty direct message channels for the calling user. |
mpim.mark | Deprecated. Sets the read cursor in a multiparty direct message channel. |
mpim.open | Deprecated. This method opens a multiparty direct message. |
mpim.replies | Deprecated. 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.