APIHub
Back to Explore

Slack

The Slack API offers programmatic control over a wide range of workspace and enterprise‑grid functions, including ending calls, adding remote files, and extensive admin capabilities such as creating, renaming, archiving, and managing channels, apps, emojis, invitations, teams, user groups, and users.

Social
OAuth
HTTPS
CORS: Unknown
Description enriched
Visit official documentation

Latency

1211ms p95

Uptime

100.0% 30d

Playground

Verified

live

Endpoints

REST · JSON
POST

/calls.end

Ends a Call.

  • token (header, required) — Authentication token. Requires scope: `calls:write`
POST

/files.remote.add

Adds a file from a remote service

POST

/admin.conversations.invite

Invite a user to a public or private channel.

  • token (header, required) — Authentication token. Requires scope: `admin.conversations:write`
POST

/admin.apps.approve

Approve an app for installation on a workspace.

  • token (header, required) — Authentication token. Requires scope: `admin.apps:write`
GET

/admin.apps.approved.list

List approved apps for an org or workspace.

  • token (query, required) — Authentication token. Requires scope: `admin.apps:read`
  • limit (query, limit) — The maximum number of items to return. Must be between 1 - 1000 both inclusive.
  • cursor (query) — Set `cursor` to `next_cursor` returned by the previous call to list items in the next page
  • team_id (query)
  • enterprise_id (query)
GET

/admin.conversations.getTeams

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

  • token (header, required) — Authentication token. Requires scope: `admin.conversations:read`
  • channel_id (query, required) — The channel to determine connected workspaces within the organization for.
  • cursor (query) — Set `cursor` to `next_cursor` returned by the previous call to list items in the next page
  • limit (query, limit) — The maximum number of items to return. Must be between 1 - 1000 both inclusive.
POST

/admin.conversations.rename

Rename a public or private channel.

  • token (header, required) — Authentication token. Requires scope: `admin.conversations:write`
GET

/admin.apps.requests.list

List app requests for a team/workspace.

  • token (query, required) — Authentication token. Requires scope: `admin.apps:read`
  • limit (query, limit) — The maximum number of items to return. Must be between 1 - 1000 both inclusive.
  • cursor (query) — Set `cursor` to `next_cursor` returned by the previous call to list items in the next page
  • team_id (query)
POST

/admin.apps.restrict

Restrict an app for installation on a workspace.

  • token (header, required) — Authentication token. Requires scope: `admin.apps:write`
GET

/admin.apps.restricted.list

List restricted apps for an org or workspace.

  • token (query, required) — Authentication token. Requires scope: `admin.apps:read`
  • limit (query, limit) — The maximum number of items to return. Must be between 1 - 1000 both inclusive.
  • cursor (query) — Set `cursor` to `next_cursor` returned by the previous call to list items in the next page
  • team_id (query)
  • enterprise_id (query)
POST

/admin.conversations.archive

Archive a public or private channel.

  • token (header, required) — Authentication token. Requires scope: `admin.conversations:write`
POST

/admin.conversations.convertToPrivate

Convert a public channel to a private channel.

  • token (header, required) — Authentication token. Requires scope: `admin.conversations:write`
POST

/admin.conversations.create

Create a public or private channel-based conversation.

  • token (header, required) — Authentication token. Requires scope: `admin.conversations:write`
POST

/admin.conversations.delete

Delete a public or private channel.

  • token (header, required) — Authentication token. Requires scope: `admin.conversations:write`
POST

/admin.conversations.disconnectShared

Disconnect a connected channel from one or more workspaces.

  • token (header, required) — Authentication token. Requires scope: `admin.conversations:write`
GET

/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.

  • token (query, required) — Authentication token. Requires scope: `admin.conversations:read`
  • channel_ids (query) — A comma-separated list of channels to filter to.
  • team_ids (query) — A comma-separated list of the workspaces to which the channels you would like returned belong.
  • limit (query, limit) — The maximum number of items to return. Must be between 1 - 1000 both inclusive.
  • cursor (query) — Set `cursor` to `next_cursor` returned by the previous call to list items in the next page.
GET

/admin.conversations.getConversationPrefs

Get conversation preferences for a public or private channel.

  • token (header, required) — Authentication token. Requires scope: `admin.conversations:read`
  • channel_id (query, required) — The channel to get preferences for.
POST

/admin.conversations.restrictAccess.addGroup

Add an allowlist of IDP groups for accessing a channel

GET

/admin.conversations.restrictAccess.listGroups

List all IDP Groups linked to a channel

  • token (query, required) — Authentication token. Requires scope: `admin.conversations:read`
  • channel_id (query, required)
  • team_id (query) — The workspace where the channel exists. This argument is required for channels only tied to one workspace, and optional for channels that are shared across an organization.
POST

/admin.conversations.restrictAccess.removeGroup

Remove a linked IDP group linked from a private channel

GET

/admin.conversations.search

Search for public or private channels in an Enterprise organization.

  • token (header, required) — Authentication token. Requires scope: `admin.conversations:read`
  • team_ids (query) — Comma separated string of team IDs, signifying the workspaces to search through.
  • query (query) — Name of the the channel to query by.
  • limit (query, limit) — Maximum number of items to be returned. Must be between 1 - 20 both inclusive. Default is 10.
  • cursor (query) — Set `cursor` to `next_cursor` returned by the previous call to list items in the next page.
  • search_channel_types (query) — The type of channel to include or exclude in the search. For example `private` will search private channels, while `private_exclude` will exclude them. For a full list of types, check the [Types section](#types).
  • sort (query) — Possible values are `relevant` (search ranking based on what we think is closest), `name` (alphabetical), `member_count` (number of users in the channel), and `created` (date channel was created). You can optionally pair this with the `sort_dir` arg to change how it is sorted
  • sort_dir (query) — Sort direction. Possible values are `asc` for ascending order like (1, 2, 3) or (a, b, c), and `desc` for descending order like (3, 2, 1) or (c, b, a)
POST

/admin.conversations.setConversationPrefs

Set the posting permissions for a public or private channel.

  • token (header, required) — Authentication token. Requires scope: `admin.conversations:write`
POST

/admin.conversations.setTeams

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

  • token (header, required) — Authentication token. Requires scope: `admin.conversations:write`
POST

/admin.conversations.unarchive

Unarchive a public or private channel.

  • token (header, required) — Authentication token. Requires scope: `admin.conversations:write`
POST

/admin.emoji.add

Add an emoji.

POST

/admin.emoji.addAlias

Add an emoji alias.

GET

/admin.emoji.list

List emoji for an Enterprise Grid organization.

  • token (query, required) — Authentication token. Requires scope: `admin.teams:read`
  • cursor (query) — Set `cursor` to `next_cursor` returned by the previous call to list items in the next page
  • limit (query, limit) — The maximum number of items to return. Must be between 1 - 1000 both inclusive.
POST

/admin.emoji.remove

Remove an emoji across an Enterprise Grid organization

POST

/admin.emoji.rename

Rename an emoji.

POST

/admin.inviteRequests.approve

Approve a workspace invite request.

  • token (header, required) — Authentication token. Requires scope: `admin.invites:write`
POST

/admin.teams.settings.setName

Set the name of a given workspace.

  • token (header, required) — Authentication token. Requires scope: `admin.teams:write`
GET

/admin.inviteRequests.approved.list

List all approved workspace invite requests.

  • token (header, required) — Authentication token. Requires scope: `admin.invites:read`
  • team_id (query) — ID for the workspace where the invite requests were made.
  • cursor (query) — Value of the `next_cursor` field sent as part of the previous API response
  • limit (query, limit) — The number of results that will be returned by the API on each invocation. Must be between 1 - 1000, both inclusive
GET

/admin.inviteRequests.denied.list

List all denied workspace invite requests.

  • token (header, required) — Authentication token. Requires scope: `admin.invites:read`
  • team_id (query) — ID for the workspace where the invite requests were made.
  • cursor (query) — Value of the `next_cursor` field sent as part of the previous api response
  • limit (query, limit) — The number of results that will be returned by the API on each invocation. Must be between 1 - 1000 both inclusive
POST

/admin.inviteRequests.deny

Deny a workspace invite request.

  • token (header, required) — Authentication token. Requires scope: `admin.invites:write`
GET

/admin.inviteRequests.list

List all pending workspace invite requests.

  • token (header, required) — Authentication token. Requires scope: `admin.invites:read`
  • team_id (query) — ID for the workspace where the invite requests were made.
  • cursor (query) — Value of the `next_cursor` field sent as part of the previous API response
  • limit (query, limit) — The number of results that will be returned by the API on each invocation. Must be between 1 - 1000, both inclusive
GET

/admin.teams.admins.list

List all of the admins on a given workspace.

  • token (query, required) — Authentication token. Requires scope: `admin.teams:read`
  • limit (query, limit) — The maximum number of items to return.
  • cursor (query) — Set `cursor` to `next_cursor` returned by the previous call to list items in the next page.
  • team_id (query, required)
POST

/admin.teams.create

Create an Enterprise team.

  • token (header, required) — Authentication token. Requires scope: `admin.teams:write`
GET

/admin.teams.list

List all teams on an Enterprise organization

  • token (header, required) — Authentication token. Requires scope: `admin.teams:read`
  • limit (query, limit) — The maximum number of items to return. Must be between 1 - 100 both inclusive.
  • cursor (query) — Set `cursor` to `next_cursor` returned by the previous call to list items in the next page.
GET

/admin.teams.owners.list

List all of the owners on a given workspace.

  • token (query, required) — Authentication token. Requires scope: `admin.teams:read`
  • team_id (query, required)
  • limit (query, limit) — The maximum number of items to return. Must be between 1 - 1000 both inclusive.
  • cursor (query) — Set `cursor` to `next_cursor` returned by the previous call to list items in the next page.
GET

/admin.teams.settings.info

Fetch information about settings in a workspace

  • token (header, required) — Authentication token. Requires scope: `admin.teams:read`
  • team_id (query, required)
POST

/admin.teams.settings.setDefaultChannels

Set the default channels of a workspace.

POST

/admin.teams.settings.setDescription

Set the description of a given workspace.

  • token (header, required) — Authentication token. Requires scope: `admin.teams:write`
POST

/admin.teams.settings.setDiscoverability

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

  • token (header, required) — Authentication token. Requires scope: `admin.teams:write`
POST

/admin.teams.settings.setIcon

Sets the icon of a workspace.

POST

/admin.usergroups.addChannels

Add one or more default channels to an IDP group.

  • token (header, required) — Authentication token. Requires scope: `admin.usergroups:write`
POST

/admin.usergroups.addTeams

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

  • token (header, required) — Authentication token. Requires scope: `admin.teams:write`
GET

/admin.usergroups.listChannels

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

  • token (header, required) — Authentication token. Requires scope: `admin.usergroups:read`
  • usergroup_id (query, required) — ID of the IDP group to list default channels for.
  • team_id (query) — ID of the the workspace.
  • include_num_members (query) — Flag to include or exclude the count of members per channel.
POST

/admin.usergroups.removeChannels

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

  • token (header, required) — Authentication token. Requires scope: `admin.usergroups:write`
POST

/admin.users.assign

Add an Enterprise user to a workspace.

  • token (header, required) — Authentication token. Requires scope: `admin.users:write`
POST

/admin.users.invite

Invite a user to a workspace.

  • token (header, required) — Authentication token. Requires scope: `admin.users:write`
GET

/admin.users.list

List users on a workspace

  • token (header, required) — Authentication token. Requires scope: `admin.users:read`
  • team_id (query, required) — The ID (`T1234`) of the workspace.
  • cursor (query) — Set `cursor` to `next_cursor` returned by the previous call to list items in the next page.
  • limit (query, limit) — Limit for how many users to be retrieved per page
POST

/admin.users.remove

Remove a user from a workspace.

  • token (header, required) — Authentication token. Requires scope: `admin.users:write`
POST

/admin.users.session.invalidate

Invalidate a single session for a user by session_id

  • token (header, required) — Authentication token. Requires scope: `admin.users:write`
POST

/admin.users.session.reset

Wipes all valid sessions on all devices for a given user

  • token (header, required) — Authentication token. Requires scope: `admin.users:write`
POST

/admin.users.setAdmin

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

  • token (header, required) — Authentication token. Requires scope: `admin.users:write`
POST

/admin.users.setExpiration

Set an expiration for a guest user

  • token (header, required) — Authentication token. Requires scope: `admin.users:write`
POST

/admin.users.setOwner

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

  • token (header, required) — Authentication token. Requires scope: `admin.users:write`
POST

/admin.users.setRegular

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

  • token (header, required) — Authentication token. Requires scope: `admin.users:write`
GET

/api.test

Checks API calling code.

  • error (query) — Error response to return
  • foo (query) — example property to return
GET

/bots.info

Gets information about a bot user.

  • token (query, required) — Authentication token. Requires scope: `users:read`
  • bot (query) — Bot user to get info on
GET

/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.

  • token (header, required) — Authentication token. Requires scope: `authorizations:read`
  • event_context (query, required)
  • cursor (query)
  • limit (query, limit)
GET

/apps.permissions.info

Returns list of permissions this app has on a team.

  • token (query) — Authentication token. Requires scope: `none`
GET

/apps.permissions.request

Allows an app to request additional scopes

  • token (query, required) — Authentication token. Requires scope: `none`
  • scopes (query, required) — A comma separated list of scopes to request for
  • trigger_id (query, required) — Token used to trigger the permissions API
GET

/apps.permissions.resources.list

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

  • token (query, required) — Authentication token. Requires scope: `none`
  • cursor (query) — Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`. Default value fetches the first "page" of the collection. See [pagination](/docs/pagination) for more detail.
  • limit (query, limit) — The maximum number of items to return.
GET

/apps.permissions.scopes.list

Returns list of scopes this app has on a team.

  • token (query, required) — Authentication token. Requires scope: `none`
GET

/apps.permissions.users.list

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

  • token (query, required) — Authentication token. Requires scope: `none`
  • cursor (query) — Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`. Default value fetches the first "page" of the collection. See [pagination](/docs/pagination) for more detail.
  • limit (query, limit) — The maximum number of items to return.
GET

/apps.permissions.users.request

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

  • token (query, required) — Authentication token. Requires scope: `none`
  • scopes (query, required) — A comma separated list of user scopes to request for
  • trigger_id (query, required) — Token used to trigger the request
  • user (query, required) — The user this scope is being requested for
GET

/apps.uninstall

Uninstalls your app from a workspace.

  • token (query) — Authentication token. Requires scope: `none`
  • client_id (query) — Issued when you created your application.
  • client_secret (query) — Issued when you created your application.
GET

/auth.revoke

Revokes a token.

  • token (query, required) — Authentication token. Requires scope: `none`
  • test (query) — Setting this parameter to `1` triggers a _testing mode_ where the specified token will not actually be revoked.
GET

/auth.test

Checks authentication & identity.

  • token (header, required) — Authentication token. Requires scope: `none`
POST

/calls.add

Registers a new Call.

  • token (header, required) — Authentication token. Requires scope: `calls:write`
GET

/calls.info

Returns information about a Call.

  • token (header, required) — Authentication token. Requires scope: `calls:read`
  • id (query, required) — `id` of the Call returned by the [`calls.add`](/methods/calls.add) method.
POST

/calls.participants.add

Registers new participants added to a Call.

  • token (header, required) — Authentication token. Requires scope: `calls:write`
POST

/calls.participants.remove

Registers participants removed from a Call.

  • token (header, required) — Authentication token. Requires scope: `calls:write`
POST

/calls.update

Updates information about a Call.

  • token (header, required) — Authentication token. Requires scope: `calls:write`
POST

/chat.delete

Deletes a message.

  • token (header) — Authentication token. Requires scope: `chat:write`
POST

/chat.deleteScheduledMessage

Deletes a pending scheduled message from the queue.

  • token (header, required) — Authentication token. Requires scope: `chat:write`
GET

/chat.getPermalink

Retrieve a permalink URL for a specific extant message

  • token (query, required) — Authentication token. Requires scope: `none`
  • channel (query, required) — The ID of the conversation or channel containing the message
  • message_ts (query, required) — A message's `ts` value, uniquely identifying it within a channel
POST

/chat.meMessage

Share a me message into a channel.

  • token (header) — Authentication token. Requires scope: `chat:write`
POST

/chat.postEphemeral

Sends an ephemeral message to a user in a channel.

  • token (header, required) — Authentication token. Requires scope: `chat:write`
POST

/chat.postMessage

Sends a message to a channel.

  • token (header, required) — Authentication token. Requires scope: `chat:write`
POST

/chat.scheduleMessage

Schedules a message to be sent to a channel.

  • token (header) — Authentication token. Requires scope: `chat:write`
GET

/chat.scheduledMessages.list

Returns a list of scheduled messages.

  • token (header) — Authentication token. Requires scope: `none`
  • channel (query) — The channel of the scheduled messages
  • latest (query) — A UNIX timestamp of the latest value in the time range
  • oldest (query) — A UNIX timestamp of the oldest value in the time range
  • limit (query, limit) — Maximum number of original entries to return.
  • cursor (query) — For pagination purposes, this is the `cursor` value returned from a previous call to `chat.scheduledmessages.list` indicating where you want to start this call from.
POST

/chat.unfurl

Provide custom unfurl behavior for user-posted URLs

  • token (header, required) — Authentication token. Requires scope: `links:write`
POST

/chat.update

Updates a message.

  • token (header, required) — Authentication token. Requires scope: `chat:write`
POST

/conversations.archive

Archives a conversation.

  • token (header) — Authentication token. Requires scope: `conversations:write`
POST

/conversations.close

Closes a direct message or multi-person direct message.

  • token (header) — Authentication token. Requires scope: `conversations:write`
POST

/conversations.create

Initiates a public or private channel-based conversation

  • token (header) — Authentication token. Requires scope: `conversations:write`
GET

/conversations.history

Fetches a conversation's history of messages and events.

  • token (query) — Authentication token. Requires scope: `conversations:history`
  • channel (query) — Conversation ID to fetch history for.
  • latest (query) — End of time range of messages to include in results.
  • oldest (query) — Start of time range of messages to include in results.
  • inclusive (query) — Include messages with latest or oldest timestamp in results only when either timestamp is specified.
  • limit (query, limit) — The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached.
  • cursor (query) — Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`. Default value fetches the first "page" of the collection. See [pagination](/docs/pagination) for more detail.
GET

/conversations.info

Retrieve information about a conversation.

  • token (query) — Authentication token. Requires scope: `conversations:read`
  • channel (query) — Conversation ID to learn more about
  • include_locale (query) — Set this to `true` to receive the locale for this conversation. Defaults to `false`
  • include_num_members (query) — Set to `true` to include the member count for the specified conversation. Defaults to `false`
POST

/conversations.invite

Invites users to a channel.

  • token (header) — Authentication token. Requires scope: `conversations:write`
POST

/conversations.join

Joins an existing conversation.

  • token (header) — Authentication token. Requires scope: `channels:write`
POST

/conversations.kick

Removes a user from a conversation.

  • token (header) — Authentication token. Requires scope: `conversations:write`
POST

/conversations.leave

Leaves a conversation.

  • token (header) — Authentication token. Requires scope: `conversations:write`
GET

/conversations.list

Lists all channels in a Slack team.

  • token (query) — Authentication token. Requires scope: `conversations:read`
  • exclude_archived (query) — Set to `true` to exclude archived channels from the list
  • types (query) — Mix and match channel types by providing a comma-separated list of any combination of `public_channel`, `private_channel`, `mpim`, `im`
  • limit (query, limit) — The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached. Must be an integer no larger than 1000.
  • cursor (query) — Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`. Default value fetches the first "page" of the collection. See [pagination](/docs/pagination) for more detail.
POST

/conversations.mark

Sets the read cursor in a channel.

  • token (header) — Authentication token. Requires scope: `conversations:write`
GET

/conversations.members

Retrieve members of a conversation.

  • token (query) — Authentication token. Requires scope: `conversations:read`
  • channel (query) — ID of the conversation to retrieve members for
  • limit (query, limit) — The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached.
  • cursor (query) — Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`. Default value fetches the first "page" of the collection. See [pagination](/docs/pagination) for more detail.
POST

/conversations.open

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

  • token (header) — Authentication token. Requires scope: `conversations:write`
POST

/conversations.rename

Renames a conversation.

  • token (header) — Authentication token. Requires scope: `conversations:write`
GET

/conversations.replies

Retrieve a thread of messages posted to a conversation

  • token (query) — Authentication token. Requires scope: `conversations:history`
  • channel (query) — Conversation ID to fetch thread from.
  • ts (query) — Unique identifier of a thread's parent message. `ts` must be the timestamp of an existing message with 0 or more replies. If there are no replies then just the single message referenced by `ts` will return - it is just an ordinary, unthreaded message.
  • latest (query) — End of time range of messages to include in results.
  • oldest (query) — Start of time range of messages to include in results.
  • inclusive (query) — Include messages with latest or oldest timestamp in results only when either timestamp is specified.
  • limit (query, limit) — The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached.
  • cursor (query) — Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`. Default value fetches the first "page" of the collection. See [pagination](/docs/pagination) for more detail.
POST

/conversations.setPurpose

Sets the purpose for a conversation.

  • token (header) — Authentication token. Requires scope: `conversations:write`
POST

/conversations.setTopic

Sets the topic for a conversation.

  • token (header) — Authentication token. Requires scope: `conversations:write`
POST

/conversations.unarchive

Reverses conversation archival.

  • token (header) — Authentication token. Requires scope: `conversations:write`
GET

/dialog.open

Open a dialog with a user

  • token (header, required) — Authentication token. Requires scope: `none`
  • dialog (query, required) — The dialog definition. This must be a JSON-encoded string.
  • trigger_id (query, required) — Exchange a trigger to post to the user.
POST

/dnd.endDnd

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

  • token (header, required) — Authentication token. Requires scope: `dnd:write`
POST

/dnd.endSnooze

Ends the current user's snooze mode immediately.

  • token (header, required) — Authentication token. Requires scope: `dnd:write`
GET

/dnd.info

Retrieves a user's current Do Not Disturb status.

  • token (query) — Authentication token. Requires scope: `dnd:read`
  • user (query) — User to fetch status for (defaults to current user)
POST

/dnd.setSnooze

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

GET

/dnd.teamInfo

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

  • token (query) — Authentication token. Requires scope: `dnd:read`
  • users (query) — Comma-separated list of users to fetch Do Not Disturb status for
GET

/emoji.list

Lists custom emoji for a team.

  • token (query, required) — Authentication token. Requires scope: `emoji:read`
POST

/files.comments.delete

Deletes an existing comment on a file.

  • token (header) — Authentication token. Requires scope: `files:write:user`
POST

/files.delete

Deletes a file.

  • token (header) — Authentication token. Requires scope: `files:write:user`
GET

/files.info

Gets information about a file.

  • token (query) — Authentication token. Requires scope: `files:read`
  • file (query) — Specify a file by providing its ID.
  • count (query, limit)
  • page (query, page)
  • limit (query, limit) — The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached.
  • cursor (query) — Parameter for pagination. File comments are paginated for a single file. Set `cursor` equal to the `next_cursor` attribute returned by the previous request's `response_metadata`. This parameter is optional, but pagination is mandatory: the default value simply fetches the first "page" of the collection of comments. See [pagination](/docs/pagination) for more details.
GET

/files.list

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

  • token (query) — Authentication token. Requires scope: `files:read`
  • user (query) — Filter files created by a single user.
  • channel (query) — Filter files appearing in a specific channel, indicated by its ID.
  • ts_from (query) — Filter files created after this timestamp (inclusive).
  • ts_to (query) — Filter files created before this timestamp (inclusive).
  • types (query) — Filter files by type ([see below](#file_types)). You can pass multiple values in the types argument, like `types=spaces,snippets`.The default value is `all`, which does not filter the list.
  • count (query, limit)
  • page (query, page)
  • show_files_hidden_by_limit (query) — Show truncated file info for files hidden due to being too old, and the team who owns the file being over the file limit.
GET

/files.remote.info

Retrieve information about a remote file added to Slack

  • token (query) — Authentication token. Requires scope: `remote_files:read`
  • file (query) — Specify a file by providing its ID.
  • external_id (query) — Creator defined GUID for the file.
GET

/files.remote.list

Retrieve information about a remote file added to Slack

  • token (query) — Authentication token. Requires scope: `remote_files:read`
  • channel (query) — Filter files appearing in a specific channel, indicated by its ID.
  • ts_from (query) — Filter files created after this timestamp (inclusive).
  • ts_to (query) — Filter files created before this timestamp (inclusive).
  • limit (query, limit) — The maximum number of items to return.
  • cursor (query) — Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`. Default value fetches the first "page" of the collection. See [pagination](/docs/pagination) for more detail.
POST

/files.remote.remove

Remove a remote file.

GET

/files.remote.share

Share a remote file into a channel.

  • token (query) — Authentication token. Requires scope: `remote_files:share`
  • file (query) — Specify a file registered with Slack by providing its ID. Either this field or `external_id` or both are required.
  • external_id (query) — The globally unique identifier (GUID) for the file, as set by the app registering the file with Slack. Either this field or `file` or both are required.
  • channels (query) — Comma-separated list of channel IDs where the file will be shared.
POST

/files.remote.update

Updates an existing remote file.

POST

/files.revokePublicURL

Revokes public/external sharing access for a file

  • token (header) — Authentication token. Requires scope: `files:write:user`
POST

/files.sharedPublicURL

Enables a file for public/external sharing.

  • token (header) — Authentication token. Requires scope: `files:write:user`
POST

/files.upload

Uploads or creates a file.

GET

/migration.exchange

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

  • token (query, required) — Authentication token. Requires scope: `tokens.basic`
  • users (query, required) — A comma-separated list of user ids, up to 400 per request
  • team_id (query) — Specify team_id starts with `T` in case of Org Token
  • to_old (query) — Specify `true` to convert `W` global user IDs to workspace-specific `U` IDs. Defaults to `false`.
GET

/oauth.access

Exchanges a temporary OAuth verifier code for an access token.

  • client_id (query) — Issued when you created your application.
  • client_secret (query) — Issued when you created your application.
  • code (query) — The `code` param returned via the OAuth callback.
  • redirect_uri (query) — This must match the originally submitted URI (if one was sent).
  • single_channel (query) — Request the user to add your app only to a single channel. Only valid with a [legacy workspace app](https://api.slack.com/legacy-workspace-apps).
GET

/oauth.token

Exchanges a temporary OAuth verifier code for a workspace token.

  • client_id (query) — Issued when you created your application.
  • client_secret (query) — Issued when you created your application.
  • code (query) — The `code` param returned via the OAuth callback.
  • redirect_uri (query) — This must match the originally submitted URI (if one was sent).
  • single_channel (query) — Request the user to add your app only to a single channel.
GET

/oauth.v2.access

Exchanges a temporary OAuth verifier code for an access token.

  • client_id (query) — Issued when you created your application.
  • client_secret (query) — Issued when you created your application.
  • code (query, required) — The `code` param returned via the OAuth callback.
  • redirect_uri (query) — This must match the originally submitted URI (if one was sent).
POST

/pins.add

Pins an item to a channel.

  • token (header, required) — Authentication token. Requires scope: `pins:write`
GET

/pins.list

Lists items pinned to a channel.

  • token (query, required) — Authentication token. Requires scope: `pins:read`
  • channel (query, required) — Channel to get pinned items for.
POST

/pins.remove

Un-pins an item from a channel.

  • token (header, required) — Authentication token. Requires scope: `pins:write`
POST

/reactions.add

Adds a reaction to an item.

  • token (header, required) — Authentication token. Requires scope: `reactions:write`
GET

/reactions.get

Gets reactions for an item.

  • token (query, required) — Authentication token. Requires scope: `reactions:read`
  • channel (query) — Channel where the message to get reactions for was posted.
  • file (query) — File to get reactions for.
  • file_comment (query) — File comment to get reactions for.
  • full (query) — If true always return the complete reaction list.
  • timestamp (query) — Timestamp of the message to get reactions for.
GET

/reactions.list

Lists reactions made by a user.

  • token (query, required) — Authentication token. Requires scope: `reactions:read`
  • user (query) — Show reactions made by this user. Defaults to the authed user.
  • full (query) — If true always return the complete reaction list.
  • count (query, limit)
  • page (query, page)
  • cursor (query) — Parameter for pagination. Set `cursor` equal to the `next_cursor` attribute returned by the previous request's `response_metadata`. This parameter is optional, but pagination is mandatory: the default value simply fetches the first "page" of the collection. See [pagination](/docs/pagination) for more details.
  • limit (query, limit) — The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached.
POST

/reactions.remove

Removes a reaction from an item.

  • token (header, required) — Authentication token. Requires scope: `reactions:write`
POST

/reminders.add

Creates a reminder.

  • token (header, required) — Authentication token. Requires scope: `reminders:write`
POST

/reminders.complete

Marks a reminder as complete.

  • token (header) — Authentication token. Requires scope: `reminders:write`
POST

/reminders.delete

Deletes a reminder.

  • token (header) — Authentication token. Requires scope: `reminders:write`
GET

/reminders.info

Gets information about a reminder.

  • token (query) — Authentication token. Requires scope: `reminders:read`
  • reminder (query) — The ID of the reminder
GET

/reminders.list

Lists all reminders created by or for a given user.

  • token (query) — Authentication token. Requires scope: `reminders:read`
GET

/rtm.connect

Starts a Real Time Messaging session.

  • token (query, required) — Authentication token. Requires scope: `rtm:stream`
  • batch_presence_aware (query) — Batch presence deliveries via subscription. Enabling changes the shape of `presence_change` events. See [batch presence](/docs/presence-and-status#batching).
  • presence_sub (query) — Only deliver presence events when requested by subscription. See [presence subscriptions](/docs/presence-and-status#subscriptions).
GET

/search.messages

Searches for messages matching a query.

  • token (query, required) — Authentication token. Requires scope: `search:read`
  • count (query, limit) — Pass the number of results you want per "page". Maximum of `100`.
  • highlight (query) — Pass a value of `true` to enable query highlight markers (see below).
  • page (query, page)
  • query (query, required) — Search query.
  • sort (query) — Return matches sorted by either `score` or `timestamp`.
  • sort_dir (query) — Change sort direction to ascending (`asc`) or descending (`desc`).
POST

/stars.add

Adds a star to an item.

  • token (header, required) — Authentication token. Requires scope: `stars:write`
GET

/stars.list

Lists stars for a user.

  • token (query) — Authentication token. Requires scope: `stars:read`
  • count (query, limit)
  • page (query, page)
  • cursor (query) — Parameter for pagination. Set `cursor` equal to the `next_cursor` attribute returned by the previous request's `response_metadata`. This parameter is optional, but pagination is mandatory: the default value simply fetches the first "page" of the collection. See [pagination](/docs/pagination) for more details.
  • limit (query, limit) — The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached.
POST

/stars.remove

Removes a star from an item.

  • token (header, required) — Authentication token. Requires scope: `stars:write`
GET

/team.accessLogs

Gets the access logs for the current team.

  • token (query, required) — Authentication token. Requires scope: `admin`
  • before (query) — End of time range of logs to include in results (inclusive).
  • count (query, limit)
  • page (query, page)
GET

/team.billableInfo

Gets billable users information for the current team.

  • token (query, required) — Authentication token. Requires scope: `admin`
  • user (query) — A user to retrieve the billable information for. Defaults to all users.
GET

/team.info

Gets information about the current team.

  • token (query, required) — Authentication token. Requires scope: `team:read`
  • team (query) — Team to get info on, if omitted, will return information about the current team. Will only return team that the authenticated token is allowed to see through external shared channels
GET

/team.integrationLogs

Gets the integration logs for the current team.

  • token (query, required) — Authentication token. Requires scope: `admin`
  • app_id (query) — Filter logs to this Slack app. Defaults to all logs.
  • change_type (query) — Filter logs with this change type. Defaults to all logs.
  • count (query, limit)
  • page (query, page)
  • service_id (query) — Filter logs to this service. Defaults to all logs.
  • user (query) — Filter logs generated by this user’s actions. Defaults to all logs.
GET

/team.profile.get

Retrieve a team's profile.

  • token (query, required) — Authentication token. Requires scope: `users.profile:read`
  • visibility (query) — Filter by visibility.
POST

/usergroups.create

Create a User Group

  • token (header, required) — Authentication token. Requires scope: `usergroups:write`
POST

/usergroups.disable

Disable an existing User Group

  • token (header, required) — Authentication token. Requires scope: `usergroups:write`
POST

/usergroups.enable

Enable a User Group

  • token (header, required) — Authentication token. Requires scope: `usergroups:write`
GET

/usergroups.list

List all User Groups for a team

  • include_users (query) — Include the list of users for each User Group.
  • token (query, required) — Authentication token. Requires scope: `usergroups:read`
  • include_count (query) — Include the number of users in each User Group.
  • include_disabled (query) — Include disabled User Groups.
POST

/usergroups.update

Update an existing User Group

  • token (header, required) — Authentication token. Requires scope: `usergroups:write`
GET

/usergroups.users.list

List all users in a User Group

  • token (query, required) — Authentication token. Requires scope: `usergroups:read`
  • include_disabled (query) — Allow results that involve disabled User Groups.
  • usergroup (query, required) — The encoded ID of the User Group to update.
POST

/usergroups.users.update

Update the list of users for a User Group

  • token (header, required) — Authentication token. Requires scope: `usergroups:write`
GET

/users.conversations

List conversations the calling user may access.

  • token (query) — Authentication token. Requires scope: `conversations:read`
  • user (query) — Browse conversations by a specific user ID's membership. Non-public channels are restricted to those where the calling user shares membership.
  • types (query) — Mix and match channel types by providing a comma-separated list of any combination of `public_channel`, `private_channel`, `mpim`, `im`
  • exclude_archived (query) — Set to `true` to exclude archived channels from the list
  • limit (query, limit) — The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached. Must be an integer no larger than 1000.
  • cursor (query) — Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`. Default value fetches the first "page" of the collection. See [pagination](/docs/pagination) for more detail.
POST

/users.deletePhoto

Delete the user profile photo

GET

/users.getPresence

Gets user presence information.

  • token (query, required) — Authentication token. Requires scope: `users:read`
  • user (query) — User to get presence info on. Defaults to the authed user.
GET

/users.identity

Get a user's identity.

  • token (query) — Authentication token. Requires scope: `identity.basic`
GET

/users.info

Gets information about a user.

  • token (query, required) — Authentication token. Requires scope: `users:read`
  • include_locale (query) — Set this to `true` to receive the locale for this user. Defaults to `false`
  • user (query) — User to get info on
GET

/users.list

Lists all users in a Slack team.

  • token (query) — Authentication token. Requires scope: `users:read`
  • limit (query, limit) — The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached. Providing no `limit` value will result in Slack attempting to deliver you the entire result set. If the collection is too large you may experience `limit_required` or HTTP 500 errors.
  • cursor (query) — Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`. Default value fetches the first "page" of the collection. See [pagination](/docs/pagination) for more detail.
  • include_locale (query) — Set this to `true` to receive the locale for users. Defaults to `false`
GET

/users.lookupByEmail

Find a user with an email address.

  • token (query, required) — Authentication token. Requires scope: `users:read.email`
  • email (query, required) — An email address belonging to a user in the workspace
GET

/users.profile.get

Retrieves a user's profile information.

  • token (query, required) — Authentication token. Requires scope: `users.profile:read`
  • include_labels (query) — Include labels for each ID in custom profile fields
  • user (query) — User to retrieve profile info for
POST

/users.profile.set

Set the profile information for a user.

  • token (header, required) — Authentication token. Requires scope: `users.profile:write`
POST

/users.setActive

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

  • token (header, required) — Authentication token. Requires scope: `users:write`
POST

/users.setPhoto

Set the user profile photo

POST

/users.setPresence

Manually sets user presence.

  • token (header, required) — Authentication token. Requires scope: `users:write`
GET

/views.open

Open a view for a user.

  • token (header, required) — Authentication token. Requires scope: `none`
  • trigger_id (query, required) — Exchange a trigger to post to the user.
  • view (query, required) — A [view payload](/reference/surfaces/views). This must be a JSON-encoded string.
GET

/views.publish

Publish a static view for a User.

  • token (header, required) — Authentication token. Requires scope: `none`
  • user_id (query, required) — `id` of the user you want publish a view to.
  • view (query, required) — A [view payload](/reference/surfaces/views). This must be a JSON-encoded string.
  • hash (query) — A string that represents view state to protect against possible race conditions.
GET

/views.push

Push a view onto the stack of a root view.

  • token (header, required) — Authentication token. Requires scope: `none`
  • trigger_id (query, required) — Exchange a trigger to post to the user.
  • view (query, required) — A [view payload](/reference/surfaces/views). This must be a JSON-encoded string.
GET

/views.update

Update an existing view.

  • token (header, required) — Authentication token. Requires scope: `none`
  • view_id (query) — A unique identifier of the view to be updated. Either `view_id` or `external_id` is required.
  • external_id (query) — A unique identifier of the view set by the developer. Must be unique for all views on a team. Max length of 255 characters. Either `view_id` or `external_id` is required.
  • view (query) — A [view object](/reference/surfaces/views). This must be a JSON-encoded string.
  • hash (query) — A string that represents view state to protect against possible race conditions.
GET

/workflows.stepCompleted

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

  • token (header, required) — Authentication token. Requires scope: `workflow.steps:execute`
  • workflow_step_execute_id (query, required) — Context identifier that maps to the correct workflow step execution.
  • outputs (query) — Key-value object of outputs from your step. Keys of this object reflect the configured `key` properties of your [`outputs`](/reference/workflows/workflow_step#output) array from your `workflow_step` object.
GET

/workflows.stepFailed

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

  • token (header, required) — Authentication token. Requires scope: `workflow.steps:execute`
  • workflow_step_execute_id (query, required) — Context identifier that maps to the correct workflow step execution.
  • error (query, required) — A JSON-based object with a `message` property that should contain a human readable error message.
GET

/workflows.updateStep

Update the configuration for a workflow extension step.

  • token (header, required) — Authentication token. Requires scope: `workflow.steps:execute`
  • workflow_step_edit_id (query, required) — A context identifier provided with `view_submission` payloads used to call back to `workflows.updateStep`.
  • inputs (query) — A JSON key-value map of inputs required from a user during configuration. This is the data your app expects to receive when the workflow step starts. **Please note**: the embedded variable format is set and replaced by the workflow system. You cannot create custom variables that will be replaced at runtime. [Read more about variables in workflow steps here](/workflows/steps#variables).
  • outputs (query) — An JSON array of output objects used during step execution. This is the data your app agrees to provide when your workflow step was executed.
  • step_name (query) — An optional field that can be used to override the step name that is shown in the Workflow Builder.
  • step_image_url (query) — An optional field that can be used to override app image that is shown in the Workflow Builder.

174 endpoints auto-detected

Authentication

This API requires authentication: OAuth.

curl -X POST \
  "https://api.slack.com//calls.end"

api.slack.com · HTTPS only