Description

Slack is a messaging program designed specifically for the office, but has also been adopted for personal use.

Slack brings team communication and collaboration into one place so you can get more work done, whether you belong to a large enterprise or a small business. Check off your to-do list and move your projects forward by bringing the right people, conversations, tools, and information you need together.

The Slack Web API is an interface for querying information from and enacting change in a Slack workspace. Use it on the fly for ad-hoc queries, or as part of a more complex tapestry of platform features in a Slack app.

Supported Operations

Slack Web API

Approve an app for installation on a workspace.

Approve an app for installation on a workspace. Authentication token requires scope: `admin.apps:write`

List approved apps for an org or workspace.

List approved apps for an org or workspace. Authentication token requires scope: `admin.apps:read`

List app requests for a team/workspace.

List app requests for a team/workspace. Authentication token requires scope: `admin.apps:read`

Restrict an app for installation on a workspace.

Restrict an app for installation on a workspace. Authentication token requires scope: `admin.apps:write`

List restricted apps for an org or workspace.

List restricted apps for an org or workspace. Authentication token requires scope: `admin.apps:read`

Archive a public or private channel.

Archive a public or private channel. Authentication token requires scope: `admin.conversations:write`

Convert a public channel to a private channel.

Convert a public channel to a private channel. Authentication token. Requires scope: `admin.conversations:write`

Create a public or private channel-based conversation.

Create a public or private channel-based conversation. Authentication token requires scope: `admin.conversations:write`

Delete a public or private channel.

Delete a public or private channel. Authentication token requires scope: `admin.conversations:write`

Disconnect a connected channel from one or more workspaces.

Disconnect a connected channel from one or more workspaces. Authentication token. Requires scope: `admin.conversations:write`

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.

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. Authentication token requires scope: `admin.conversations:read`

Get conversation preferences for a public or private channel.

Get conversation preferences for a public or private channel. Authentication token requires scope: `admin.conversations:read`

Get all the workspaces a given public or private channel is connected to within this Enterprise org.

Get all the workspaces a given public or private channel is connected to within this Enterprise org. Authentication token requires scope: `admin.conversations:read`

Invite a user to a public or private channel.

Invite a user to a public or private channel. Authentication token requires scope: `admin.conversations:write`

Rename a public or private channel.

Rename a public or private channel. Authentication token requires scope: `admin.conversations:write`

Add an allowlist of IDP groups for accessing a channel.

Add an allowlist of IDP groups for accessing a channel. Authentication token requires scope: `admin.conversations:write`

List all IDP Groups linked to a channel.

List all IDP Groups linked to a channel. Authentication token requires scope: `admin.conversations:read`

Remove a linked IDP group linked from a private channel.

Remove a linked IDP group linked from a private channel. Authentication token requires scope: `admin.conversations:write`

Search for public or private channels in an Enterprise organization.

Search for public or private channels in an Enterprise organization. Authentication token requires scope: `admin.conversations:read`

Set the posting permissions for a public or private channel.

Set the posting permissions for a public or private channel. Authentication token requires scope: `admin.conversations:write`

Set the workspaces in an Enterprise grid org that connect to a public or private channel.

Set the workspaces in an Enterprise grid org that connect to a public or private channel. Authentication token requires scope: `admin.conversations:write`

Unarchive a public or private channel.

Unarchive a public or private channel. Authentication token requires scope: `admin.conversations:write`

Add an emoji.

Add an emoji. Authentication token. Requires scope: `admin.teams:write`

Add an emoji alias.

Add an emoji alias. Authentication token requires scope: `admin.teams:write`

List emoji for an Enterprise Grid organization.

List emoji for an Enterprise Grid organization. Authentication token requires scope: `admin.teams:read`

Remove an emoji across an Enterprise Grid organization.

Remove an emoji across an Enterprise Grid organization. Authentication token. Requires scope: `admin.teams:write`

Rename an emoji.

Rename an emoji. Authentication token requires scope: `admin.teams:write`

Approve a workspace invite request.

Approve a workspace invite request. Authentication token requires scope: `admin.invites:write`

List all approved workspace invite requests.

List all approved workspace invite requests. Authentication token requires scope: `admin.invites:read`

List all denied workspace invite requests.

List all denied workspace invite requests. Authentication token requires scope: `admin.invites:read`

Deny a workspace invite request.

Deny a workspace invite request. Authentication token. Requires scope: `admin.invites:write`

List all pending workspace invite requests.

List all pending workspace invite requests. Authentication token requires scope: `admin.invites:read`

List all of the admins on a given workspace.

List all of the admins on a given workspace. Authentication token requires scope: `admin.teams:read`

Create an Enterprise team.

Create an Enterprise team. Authentication token requires scope: `admin.teams:write`

List all teams on an Enterprise organization.

List all teams on an Enterprise organization. Authentication token requires scope: `admin.teams:read`

List all of the owners on a given workspace.

List all of the owners on a given workspace. Authentication token requires scope: `admin.teams:read`

Fetch information about settings in a workspace.

Fetch information about settings in a workspace. Authentication token requires scope: `admin.teams:read`

Set the default channels of a workspace.

Set the default channels of a workspace. Authentication token requires scope: `admin.teams:write`

Set the description of a given workspace.

Set the description of a given workspace. Authentication token requires scope: `admin.teams:write`

An API method that allows admins to set the discoverability of a given workspace.

An API method that allows admins to set the discoverability of a given workspace. Authentication token requires scope: `admin.teams:write`

Sets the icon of a workspace.

Sets the icon of a workspace. Authentication token requires scope: `admin.teams:write`

Set the name of a given workspace.

Set the name of a given workspace. Authentication token requires scope: `admin.teams:write`

Add one or more default channels to an IDP group.

Add one or more default channels to an IDP group. Authentication token requires scope: `admin.usergroups:write`

Associate one or more default workspaces with an organization-wide IDP group.

Associate one or more default workspaces with an organization-wide IDP group. Authentication token requires scope: `admin.teams:write`

List the channels linked to an org-level IDP group (user group).

List the channels linked to an org-level IDP group (user group). Authentication token requires scope: `admin.usergroups:read`

Remove one or more default channels from an org-level IDP group (user group).

Remove one or more default channels from an org-level IDP group (user group). Authentication token requires scope: `admin.usergroups:write`

Add an Enterprise user to a workspace.

Add an Enterprise user to a workspace. Authentication token requires scope: `admin.users:write`

Invite a user to a workspace.

Invite a user to a workspace. Authentication token requires scope: `admin.users:write`

List users on a workspace.

List users on a workspace. Authentication token requires scope: `admin.users:read`

Remove a user from a workspace.

Remove a user from a workspace. Authentication token requires scope: `admin.users:write`

Invalidate a single session for a user by session_id.

Invalidate a single session for a user by session_id. Authentication token requires scope: `admin.users:write`

Wipes all valid sessions on all devices for a given user.

Wipes all valid sessions on all devices for a given user. Authentication token requires scope: `admin.users:write`

Set an existing guest, regular user, or owner to be an admin user.

Set an existing guest, regular user, or owner to be an admin user. Authentication token requires scope: `admin.users:write`

Set an expiration for a guest user.

Set an expiration for a guest user. Authentication token requires scope: `admin.users:write`

Set an existing guest, regular user, or admin user to be a workspace owner.

Set an existing guest, regular user, or admin user to be a workspace owner. Authentication token. Requires scope: `admin.users:write`

Set an existing guest user, admin user, or owner to be a regular user.

Set an existing guest user, admin user, or owner to be a regular user. Authentication token requires scope: `admin.users:write`

Checks API calling code.

Checks API calling code.

Get a list of authorizations for the given event context. Each authorization represents an app installation that the event is visible to.

Get a list of authorizations for the given event context. Each authorization represents an app installation that the event is visible to. Authentication token requires scope: `authorizations:read`

Returns list of permissions this app has on a team.

Returns list of permissions this app has on a team. Authentication token requires scope: `none`

Allows an app to request additional scopes.

Allows an app to request additional scopes. Authentication token requires scope: `none`

Returns list of resource grants this app has on a team.

Returns list of resource grants this app has on a team. Authentication token requires scope: `none`

Returns list of scopes this app has on a team.

Returns list of scopes this app has on a team. Authentication token requires scope: `none`

Returns list of user grants and corresponding scopes this app has on a team.

Returns list of user grants and corresponding scopes this app has on a team. Authentication token requires scope: `none`

Enables an app to trigger a permissions modal to grant an app access to a user access scope.

Enables an app to trigger a permissions modal to grant an app access to a user access scope. Authentication token requires scope: `none`

Uninstalls your app from a workspace.

Uninstalls your app from a workspace. Authentication token requires scope: `none`

Revokes a token.

Revokes a token. Authentication token requires scope: `none`

Checks authentication & identity.

Checks authentication & identity. Authentication token requires scope: `none`

Gets information about a bot user.

Gets information about a bot user. Authentication token requires scope: `users:read`

Registers a new Call.

Registers a new Call. Authentication token requires scope: `calls:write`

Ends a Call.

Ends a Call. Authentication token requires scope: `calls:write`

Returns information about a Call.

Returns information about a Call. Authentication token. Requires scope: `calls:read`

Registers new participants added to a Call.

Registers new participants added to a Call. Authentication token requires scope: `calls:write`

Registers participants removed from a Call.

Registers participants removed from a Call. Authentication token requires scope: `calls:write`

Updates information about a Call.

Updates information about a Call. Authentication token requires scope: `calls:write`

Deletes a message.

Deletes a message. Authentication token requires scope: `chat:write`

Deletes a pending scheduled message from the queue.

Deletes a pending scheduled message from the queue. Authentication token requires scope: `chat:write`

Retrieve a permalink URL for a specific extant message.

Retrieve a permalink URL for a specific extant message. Authentication token requires scope: `none`

Share a me message into a channel.

Share a me message into a channel. Authentication token requires scope: `chat:write`

Sends an ephemeral message to a user in a channel.

Sends an ephemeral message to a user in a channel. Authentication token requires scope: `chat:write`

Sends a message to a channel.

Sends a message to a channel. Authentication token requires scope: `chat:write`

Schedules a message to be sent to a channel.

Schedules a message to be sent to a channel. Authentication token requires scope: `chat:write`

Returns a list of scheduled messages.

Returns a list of scheduled messages. Authentication token requires scope: `none`

Provide custom unfurl behavior for user-posted URLs

Provide custom unfurl behavior for user-posted URLs Authentication token requires scope: `links:write`

Updates a message.

Updates a message. Authentication token requires scope: `chat:write`

Archives a conversation.

Archives a conversation. Authentication token requires scope: `conversations:write`

Closes a direct message or multi-person direct message.

Closes a direct message or multi-person direct message. Authentication token requires scope: `conversations:write`

Initiates a public or private channel-based conversation.

Initiates a public or private channel-based conversation. Authentication token requires scope: `conversations:write`

Fetches a conversation's history of messages and events.

Fetches a conversation's history of messages and events. Authentication token requires scope: `conversations:history`

Retrieve information about a conversation.

Retrieve information about a conversation. Authentication token requires scope: `conversations:read`

Invites users to a channel.

Invites users to a channel. Authentication token requires scope: `conversations:write`

Joins an existing conversation.

Joins an existing conversation. Authentication token requires scope: `channels:write`

Removes a user from a conversation.

Removes a user from a conversation. Authentication token requires scope: `conversations:write`

Leaves a conversation.

Leaves a conversation. Authentication token requires scope: `conversations:write`

Lists all channels in a Slack team.

Lists all channels in a Slack team. Authentication token requires scope: `conversations:read`

Sets the read cursor in a channel.

Sets the read cursor in a channel. Authentication token requires scope: `conversations:write`

Retrieve members of a conversation.

Retrieve members of a conversation. Authentication token requires scope: `conversations:read`

Opens or resumes a direct message or multi-person direct message.

Opens or resumes a direct message or multi-person direct message. Authentication token requires scope: `conversations:write`

Renames a conversation.

Renames a conversation. Authentication token requires scope: `conversations:write`

Retrieve a thread of messages posted to a conversation.

Retrieve a thread of messages posted to a conversation. Authentication token requires scope: `conversations:history`

Sets the purpose for a conversation.

Sets the purpose for a conversation. Authentication token requires scope: `conversations:write`

Sets the topic for a conversation.

Sets the topic for a conversation. Authentication token requires scope: `conversations:write`

Reverses conversation archival.

Reverses conversation archival. Authentication token requires scope: `conversations:write`

Open a dialog with a user.

Open a dialog with a user. Authentication token requires scope: `none`

Ends the current user's Do Not Disturb session immediately.

Ends the current user's Do Not Disturb session immediately. Authentication token. Requires scope: `dnd:write`

Ends the current user's snooze mode immediately.

Ends the current user's snooze mode immediately. Authentication token requires scope: `dnd:write`

Retrieves a user's current Do Not Disturb status.

Retrieves a user's current Do Not Disturb status. Authentication token requires scope: `dnd:read`

Turns on Do Not Disturb mode for the current user, or changes its duration.

Turns on Do Not Disturb mode for the current user, or changes its duration. Authentication token requires scope: `dnd:write`

Retrieves the Do Not Disturb status for up to 50 users on a team.

Retrieves the Do Not Disturb status for up to 50 users on a team. Authentication token requires scope: `dnd:read`

Lists custom emoji for a team.

Lists custom emoji for a team. Authentication token requires scope: `emoji:read`

Deletes an existing comment on a file.

Deletes an existing comment on a file. Authentication token requires scope: `files:write:user`

Deletes a file.

Deletes a file. Authentication token requires scope: `files:write:user`

Gets information about a file.

Gets information about a file. Authentication token requires scope: `files:read`

List for a team, in a channel, or from a user with applied filters.

List for a team, in a channel, or from a user with applied filters. Authentication token requires scope: `files:read`

Adds a file from a remote service.

Adds a file from a remote service. Authentication token. Requires scope: `remote_files:write`

Retrieve information about a remote file added to Slack.

Retrieve information about a remote file added to Slack. Authentication token requires scope: `remote_files:read`

Retrieve information about a remote file added to Slack.

Retrieve information about a remote file added to Slack. Authentication token requires scope: `remote_files:read`

Remove a remote file.

Remove a remote file. Authentication token. Requires scope: `remote_files:write`

Share a remote file into a channel.

Share a remote file into a channel. Authentication token requires scope: `remote_files:share`

Updates an existing remote file.

Updates an existing remote file. Authentication token requires scope: `remote_files:write`

Revokes public/external sharing access for a file.

Revokes public/external sharing access for a file. Authentication token requires scope: `files:write:user`

Enables a file for public/external sharing.

Enables a file for public/external sharing. Authentication token requires scope: `files:write:user`

Uploads or creates a file.

Uploads or creates a file. Authentication token requires scope: `files:write:user`

For Enterprise Grid workspaces, map local user IDs to global user IDs.

For Enterprise Grid workspaces, map local user IDs to global user IDs. Authentication token requires scope: `tokens.basic`

Exchanges a temporary OAuth verifier code for a workspace token.

Exchanges a temporary OAuth verifier code for a workspace token.

Exchanges a temporary OAuth verifier code for an access token.

Exchanges a temporary OAuth verifier code for an access token.

Pins an item to a channel.

Pins an item to a channel. Authentication token requires scope: `pins:write`

Lists items pinned to a channel.

Lists items pinned to a channel. Authentication token. Requires scope: `pins:read`

Un-pins an item from a channel.

Un-pins an item from a channel. Authentication token requires scope: `pins:write`

Adds a reaction to an item.

Adds a reaction to an item. Authentication token requires scope: `reactions:write`

Gets reactions for an item.

Gets reactions for an item. Authentication token requires scope: `reactions:read`

Lists reactions made by a user.

Lists reactions made by a user. Authentication token requires scope: `reactions:read`

Removes a reaction from an item.

Removes a reaction from an item. Authentication token requires scope: `reactions:write`

Creates a reminder.

Creates a reminder. Authentication token requires scope: `reminders:write`

Marks a reminder as complete.

Marks a reminder as complete. Authentication token. Requires scope: `reminders:write`

Deletes a reminder.

Deletes a reminder. Authentication token requires scope: `reminders:write`

Gets information about a reminder.

Gets information about a reminder. Authentication token requires scope: `reminders:read`

Lists all reminders created by or for a given user.

Lists all reminders created by or for a given user. Authentication token requires scope: `reminders:read`

Starts a Real Time Messaging session.

Starts a Real Time Messaging session. Authentication token requires scope: `rtm:stream`

Searches for messages matching a query.

Searches for messages matching a query. Authentication token requires scope: `search:read`

Adds a star to an item.

Adds a star to an item. Authentication token requires scope: `stars:write`

Lists stars for a user.

Lists stars for a user. Authentication token requires scope: `stars:read`

Removes a star from an item.

Removes a star from an item. Authentication token requires scope: `stars:write`

Gets the access logs for the current team.

Gets the access logs for the current team. Authentication token requires scope: `admin`

Gets billable users information for the current team.

Gets billable users information for the current team. Authentication token requires scope: `admin`

Gets information about the current team.

Gets information about the current team. Authentication token requires scope: `team:read`

Gets the integration logs for the current team.

Gets the integration logs for the current team. Authentication token requires scope: `admin`

Retrieve a team's profile.

Retrieve a team's profile. Authentication token requires scope: `users.profile:read`

Create a User Group.

Create a User Group. Authentication token requires scope: `usergroups:write`

Disable an existing User Group.

Disable an existing User Group. Authentication token requires scope: `usergroups:write`

Enable a User Group.

Enable a User Group. Authentication token requires scope: `usergroups:write`

List all User Groups for a team.

List all User Groups for a team. Authentication token requires scope: `usergroups:read`

Update an existing User Group.

Update an existing User Group. Authentication token requires scope: `usergroups:write`

List all users in a User Group.

List all users in a User Group. Authentication token requires scope: `usergroups:read`

Update the list of users for a User Group.

Update the list of users for a User Group. Authentication token requires scope: `usergroups:write`

List conversations the calling user may access.

List conversations the calling user may access. Authentication token requires scope: `conversations:read`

Delete the user profile photo.

Delete the user profile photo. Authentication token requires scope: `users.profile:write`

Gets user presence information.

Gets user presence information. Authentication token requires scope: `users:read`

Get a user's identity.

Get a user's identity. Authentication token requires scope: `identity.basic`

Gets information about a user.

Gets information about a user. Authentication token requires scope: `users:read`

Lists all users in a Slack team.

Lists all users in a Slack team. Authentication token requires scope: `users:read`

Find a user with an email address.

Find a user with an email address. Authentication token requires scope: `users:read.email`

Retrieves a user's profile information.

Retrieves a user's profile information. Authentication token requires scope: `users.profile:read`

Set the profile information for a user.

Set the profile information for a user. Authentication token requires scope: `users.profile:write`

Marked a user as active. Deprecated and non-functional.

Marked a user as active. Deprecated and non-functional. Authentication token requires scope: `users:write`

Set the user profile photo

Set the user profile photo

Manually sets user presence.

Manually sets user presence. Authentication token requires scope: `users:write`

Open a view for a user.

Open a view for a user. Authentication token requires scope: `none`

Publish a static view for a User.

Publish a static view for a User. Authentication token requires scope: `none`

Push a view onto the stack of a root view.

Push a view onto the stack of a root view. Authentication token requires scope: `none`

Update an existing view.

Update an existing view. Authentication token requires scope: `none`

Indicate that an app's step in a workflow completed execution.

Indicate that an app's step in a workflow completed execution. Authentication token requires scope: `workflow.steps:execute`

Indicate that an app's step in a workflow failed to execute.

Indicate that an app's step in a workflow failed to execute. Authentication token requires scope: `workflow.steps:execute`

Update the configuration for a workflow extension step.

Update the configuration for a workflow extension step. Authentication token requires scope: `workflow.steps:execute`

Details
Last Update

1 day ago

Includes
slack-web-client
slack-auth