Slack Web API (all endpoints)
One way to interact with the Slack platform is its HTTP RPC-based Web API, a collection of methods requiring OAuth 2.0-based user, bot, or workspace tokens…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
One way to interact with the Slack platform is its HTTP RPC-based Web API, a collection of methods requiring OAuth 2.0-based user, bot, or workspace tokens blessed with related OAuth scopes.
Endpoints 174
admin.apps
- POSTadmin_apps_approve
/admin.apps.approveApprove an app for installation on a workspace. - POSTadmin_apps_restrict
/admin.apps.restrictRestrict an app for installation on a workspace.
admin.apps.approved
- GETadmin_apps_approved_list
/admin.apps.approved.list?token=string&limit=0&cursor=string&team_id=string&enterprise_id=stringList approved apps for an org or workspace.
admin.apps.requests
- GETadmin_apps_requests_list
/admin.apps.requests.list?token=string&limit=0&cursor=string&team_id=stringList app requests for a team/workspace.
admin.apps.restricted
- GETadmin_apps_restricted_list
/admin.apps.restricted.list?token=string&limit=0&cursor=string&team_id=string&enterprise_id=stringList restricted apps for an org or workspace.
admin.conversations
- POSTadmin_conversations_archive
/admin.conversations.archiveArchive a public or private channel. - POSTadmin_conversations_convertToPrivate
/admin.conversations.convertToPrivateConvert a public channel to a private channel. - POSTadmin_conversations_create
/admin.conversations.createCreate a public or private channel-based conversation. - POSTadmin_conversations_delete
/admin.conversations.deleteDelete a public or private channel. - POSTadmin_conversations_disconnectShared
/admin.conversations.disconnectSharedDisconnect a connected channel from one or more workspaces. - GETadmin_conversations_getConversationPrefs
/admin.conversations.getConversationPrefs?channel_id=stringGet conversation preferences for a public or private channel. - GETadmin_conversations_getTeams
/admin.conversations.getTeams?channel_id=string&cursor=string&limit=0Get all the workspaces a given public or private channel is connected to within this Enterprise org. - POSTadmin_conversations_invite
/admin.conversations.inviteInvite a user to a public or private channel. - POSTadmin_conversations_rename
/admin.conversations.renameRename a public or private channel. - GETadmin_conversations_search
/admin.conversations.search?team_ids=string&query=string&limit=0&cursor=string&search_channel_types=string&sort=string&sort_dir=stringSearch for public or private channels in an Enterprise organization. - POSTadmin_conversations_setConversationPrefs
/admin.conversations.setConversationPrefsSet the posting permissions for a public or private channel. - POSTadmin_conversations_setTeams
/admin.conversations.setTeamsSet the workspaces in an Enterprise grid org that connect to a public or private channel. - POSTadmin_conversations_unarchive
/admin.conversations.unarchiveUnarchive a public or private channel.
admin.conversations.ekm
- GETadmin_conversations_ekm_listOriginalConnectedChannelInfo
/admin.conversations.ekm.listOriginalConnectedChannelInfo?token=string&channel_ids=string&team_ids=string&limit=0&cursor=stringList all disconnected channels—i.e., channels that were once connected to other workspaces and then disconnected—and the corresponding original channel IDs…
admin.conversations.restrictAccess
- POSTadmin_conversations_restrictAccess_addGroup
/admin.conversations.restrictAccess.addGroupAdd an allowlist of IDP groups for accessing a channel - GETadmin_conversations_restrictAccess_listGroups
/admin.conversations.restrictAccess.listGroups?token=string&channel_id=string&team_id=stringList all IDP Groups linked to a channel - POSTadmin_conversations_restrictAccess_removeGroup
/admin.conversations.restrictAccess.removeGroupRemove a linked IDP group linked from a private channel
admin.emoji
- POSTadmin_emoji_add
/admin.emoji.addAdd an emoji. - POSTadmin_emoji_addAlias
/admin.emoji.addAliasAdd an emoji alias. - GETadmin_emoji_list
/admin.emoji.list?token=string&cursor=string&limit=0List emoji for an Enterprise Grid organization. - POSTadmin_emoji_remove
/admin.emoji.removeRemove an emoji across an Enterprise Grid organization - POSTadmin_emoji_rename
/admin.emoji.renameRename an emoji.
admin.inviteRequests
- POSTadmin_inviteRequests_approve
/admin.inviteRequests.approveApprove a workspace invite request. - POSTadmin_inviteRequests_deny
/admin.inviteRequests.denyDeny a workspace invite request. - GETadmin_inviteRequests_list
/admin.inviteRequests.list?team_id=string&cursor=string&limit=0List all pending workspace invite requests.
admin.inviteRequests.approved
- GETadmin_inviteRequests_approved_list
/admin.inviteRequests.approved.list?team_id=string&cursor=string&limit=0List all approved workspace invite requests.
admin.inviteRequests.denied
- GETadmin_inviteRequests_denied_list
/admin.inviteRequests.denied.list?team_id=string&cursor=string&limit=0List all denied workspace invite requests.
admin.teams.admins
- GETadmin_teams_admins_list
/admin.teams.admins.list?token=string&limit=0&cursor=string&team_id=stringList all of the admins on a given workspace.
admin.teams
- POSTadmin_teams_create
/admin.teams.createCreate an Enterprise team. - GETadmin_teams_list
/admin.teams.list?limit=0&cursor=stringList all teams on an Enterprise organization
admin.teams.owners
- GETadmin_teams_owners_list
/admin.teams.owners.list?token=string&team_id=string&limit=0&cursor=stringList all of the owners on a given workspace.
admin.teams.settings
- GETadmin_teams_settings_info
/admin.teams.settings.info?team_id=stringFetch information about settings in a workspace - POSTadmin_teams_settings_setDefaultChannels
/admin.teams.settings.setDefaultChannelsSet the default channels of a workspace. - POSTadmin_teams_settings_setDescription
/admin.teams.settings.setDescriptionSet the description of a given workspace. - POSTadmin_teams_settings_setDiscoverability
/admin.teams.settings.setDiscoverabilityAn API method that allows admins to set the discoverability of a given workspace - POSTadmin_teams_settings_setIcon
/admin.teams.settings.setIconSets the icon of a workspace. - POSTadmin_teams_settings_setName
/admin.teams.settings.setNameSet the name of a given workspace.
admin.usergroups
- POSTadmin_usergroups_addChannels
/admin.usergroups.addChannelsAdd one or more default channels to an IDP group. - POSTadmin_usergroups_addTeams
/admin.usergroups.addTeamsAssociate one or more default workspaces with an organization-wide IDP group. - GETadmin_usergroups_listChannels
/admin.usergroups.listChannels?usergroup_id=string&team_id=string&include_num_members=trueList the channels linked to an org-level IDP group (user group). - POSTadmin_usergroups_removeChannels
/admin.usergroups.removeChannelsRemove one or more default channels from an org-level IDP group (user group).
admin.users
- POSTadmin_users_assign
/admin.users.assignAdd an Enterprise user to a workspace. - POSTadmin_users_invite
/admin.users.inviteInvite a user to a workspace. - GETadmin_users_list
/admin.users.list?team_id=string&cursor=string&limit=0List users on a workspace - POSTadmin_users_remove
/admin.users.removeRemove a user from a workspace. - POSTadmin_users_setAdmin
/admin.users.setAdminSet an existing guest, regular user, or owner to be an admin user. - POSTadmin_users_setExpiration
/admin.users.setExpirationSet an expiration for a guest user - POSTadmin_users_setOwner
/admin.users.setOwnerSet an existing guest, regular user, or admin user to be a workspace owner. - POSTadmin_users_setRegular
/admin.users.setRegularSet an existing guest user, admin user, or owner to be a regular user.
admin.users.session
- POSTadmin_users_session_invalidate
/admin.users.session.invalidateInvalidate a single session for a user by session_id - POSTadmin_users_session_reset
/admin.users.session.resetWipes all valid sessions on all devices for a given user
api
- GETapi_test
/api.test?error=string&foo=stringChecks API calling code.
apps.event.authorizations
- GETapps_event_authorizations_list
/apps.event.authorizations.list?event_context=string&cursor=string&limit=0Get a list of authorizations for the given event context. Each authorization represents an app installation that the event is visible to.
apps.permissions
- GETapps_permissions_info
/apps.permissions.info?token=stringReturns list of permissions this app has on a team. - GETapps_permissions_request
/apps.permissions.request?token=string&scopes=string&trigger_id=stringAllows an app to request additional scopes
apps.permissions.resources
- GETapps_permissions_resources_list
/apps.permissions.resources.list?token=string&cursor=string&limit=0Returns list of resource grants this app has on a team.
apps.permissions.scopes
- GETapps_permissions_scopes_list
/apps.permissions.scopes.list?token=stringReturns list of scopes this app has on a team.
apps.permissions.users
- GETapps_permissions_users_list
/apps.permissions.users.list?token=string&cursor=string&limit=0Returns list of user grants and corresponding scopes this app has on a team. - GETapps_permissions_users_request
/apps.permissions.users.request?token=string&scopes=string&trigger_id=string&user=stringEnables an app to trigger a permissions modal to grant an app access to a user access scope.
apps
- GETapps_uninstall
/apps.uninstall?token=string&client_id=string&client_secret=stringUninstalls your app from a workspace.
auth
- GETauth_revoke
/auth.revoke?token=string&test=trueRevokes a token. - GETauth_test
/auth.testChecks authentication & identity.
bots
- GETbots_info
/bots.info?token=string&bot=stringGets information about a bot user.
calls
- POSTcalls_add
/calls.addRegisters a new Call. - POSTcalls_end
/calls.endEnds a Call. - GETcalls_info
/calls.info?id=stringReturns information about a Call. - POSTcalls_update
/calls.updateUpdates information about a Call.
calls.participants
- POSTcalls_participants_add
/calls.participants.addRegisters new participants added to a Call. - POSTcalls_participants_remove
/calls.participants.removeRegisters participants removed from a Call.
chat
- POSTchat_delete
/chat.deleteDeletes a message. - POSTchat_deleteScheduledMessage
/chat.deleteScheduledMessageDeletes a pending scheduled message from the queue. - GETchat_getPermalink
/chat.getPermalink?token=string&channel=string&message_ts=stringRetrieve a permalink URL for a specific extant message - POSTchat_meMessage
/chat.meMessageShare a me message into a channel. - POSTchat_postEphemeral
/chat.postEphemeralSends an ephemeral message to a user in a channel. - POSTchat_postMessage
/chat.postMessageSends a message to a channel. - POSTchat_scheduleMessage
/chat.scheduleMessageSchedules a message to be sent to a channel. - POSTchat_unfurl
/chat.unfurlProvide custom unfurl behavior for user-posted URLs - POSTchat_update
/chat.updateUpdates a message.
chat.scheduledMessages
- GETchat_scheduledMessages_list
/chat.scheduledMessages.list?channel=string&latest=0.0&oldest=0.0&limit=0&cursor=stringReturns a list of scheduled messages.
conversations
- POSTconversations_archive
/conversations.archiveArchives a conversation. - POSTconversations_close
/conversations.closeCloses a direct message or multi-person direct message. - POSTconversations_create
/conversations.createInitiates a public or private channel-based conversation - GETconversations_history
/conversations.history?token=string&channel=string&latest=0.0&oldest=0.0&inclusive=true&limit=0&cursor=stringFetches a conversation's history of messages and events. - GETconversations_info
/conversations.info?token=string&channel=string&include_locale=true&include_num_members=trueRetrieve information about a conversation. - POSTconversations_invite
/conversations.inviteInvites users to a channel. - POSTconversations_join
/conversations.joinJoins an existing conversation. - POSTconversations_kick
/conversations.kickRemoves a user from a conversation. - POSTconversations_leave
/conversations.leaveLeaves a conversation. - GETconversations_list
/conversations.list?token=string&exclude_archived=true&types=string&limit=0&cursor=stringLists all channels in a Slack team. - POSTconversations_mark
/conversations.markSets the read cursor in a channel. - GETconversations_members
/conversations.members?token=string&channel=string&limit=0&cursor=stringRetrieve members of a conversation. - POSTconversations_open
/conversations.openOpens or resumes a direct message or multi-person direct message. - POSTconversations_rename
/conversations.renameRenames a conversation. - GETconversations_replies
/conversations.replies?token=string&channel=string&ts=0.0&latest=0.0&oldest=0.0&inclusive=true&limit=0&cursor=stringRetrieve a thread of messages posted to a conversation - POSTconversations_setPurpose
/conversations.setPurposeSets the purpose for a conversation. - POSTconversations_setTopic
/conversations.setTopicSets the topic for a conversation. - POSTconversations_unarchive
/conversations.unarchiveReverses conversation archival.
dialog
- GETdialog_open
/dialog.open?dialog=string&trigger_id=stringOpen a dialog with a user
dnd
- POSTdnd_endDnd
/dnd.endDndEnds the current user's Do Not Disturb session immediately. - POSTdnd_endSnooze
/dnd.endSnoozeEnds the current user's snooze mode immediately. - GETdnd_info
/dnd.info?token=string&user=stringRetrieves a user's current Do Not Disturb status. - POSTdnd_setSnooze
/dnd.setSnoozeTurns on Do Not Disturb mode for the current user, or changes its duration. - GETdnd_teamInfo
/dnd.teamInfo?token=string&users=stringRetrieves the Do Not Disturb status for up to 50 users on a team.
emoji
- GETemoji_list
/emoji.list?token=stringLists custom emoji for a team.
files.comments
- POSTfiles_comments_delete
/files.comments.deleteDeletes an existing comment on a file.
files
- POSTfiles_delete
/files.deleteDeletes a file. - GETfiles_info
/files.info?token=string&file=string&count=string&page=string&limit=0&cursor=stringGets information about a file. - GETfiles_list
/files.list?token=string&user=string&channel=string&ts_from=0.0&ts_to=0.0&types=string&count=string&page=string&show_files_hidden_by_limit=trueList for a team, in a channel, or from a user with applied filters. - POSTfiles_revokePublicURL
/files.revokePublicURLRevokes public/external sharing access for a file - POSTfiles_sharedPublicURL
/files.sharedPublicURLEnables a file for public/external sharing. - POSTfiles_upload
/files.uploadUploads or creates a file.
files.remote
- POSTfiles_remote_add
/files.remote.addAdds a file from a remote service - GETfiles_remote_info
/files.remote.info?token=string&file=string&external_id=stringRetrieve information about a remote file added to Slack - GETfiles_remote_list
/files.remote.list?token=string&channel=string&ts_from=0.0&ts_to=0.0&limit=0&cursor=stringRetrieve information about a remote file added to Slack - POSTfiles_remote_remove
/files.remote.removeRemove a remote file. - GETfiles_remote_share
/files.remote.share?token=string&file=string&external_id=string&channels=stringShare a remote file into a channel. - POSTfiles_remote_update
/files.remote.updateUpdates an existing remote file.
migration
- GETmigration_exchange
/migration.exchange?token=string&users=string&team_id=string&to_old=trueFor Enterprise Grid workspaces, map local user IDs to global user IDs
oauth
- GEToauth_access
/oauth.access?client_id=string&client_secret=string&code=string&redirect_uri=string&single_channel=trueExchanges a temporary OAuth verifier code for an access token. - GEToauth_token
/oauth.token?client_id=string&client_secret=string&code=string&redirect_uri=string&single_channel=trueExchanges a temporary OAuth verifier code for a workspace token.
oauth.v2
- GEToauth_v2_access
/oauth.v2.access?client_id=string&client_secret=string&code=string&redirect_uri=stringExchanges a temporary OAuth verifier code for an access token.
pins
- POSTpins_add
/pins.addPins an item to a channel. - GETpins_list
/pins.list?token=string&channel=stringLists items pinned to a channel. - POSTpins_remove
/pins.removeUn-pins an item from a channel.
reactions
- POSTreactions_add
/reactions.addAdds a reaction to an item. - GETreactions_get
/reactions.get?token=string&channel=string&file=string&file_comment=string&full=true×tamp=stringGets reactions for an item. - GETreactions_list
/reactions.list?token=string&user=string&full=true&count=0&page=0&cursor=string&limit=0Lists reactions made by a user. - POSTreactions_remove
/reactions.removeRemoves a reaction from an item.
reminders
- POSTreminders_add
/reminders.addCreates a reminder. - POSTreminders_complete
/reminders.completeMarks a reminder as complete. - POSTreminders_delete
/reminders.deleteDeletes a reminder. - GETreminders_info
/reminders.info?token=string&reminder=stringGets information about a reminder. - GETreminders_list
/reminders.list?token=stringLists all reminders created by or for a given user.
rtm
- GETrtm_connect
/rtm.connect?token=string&batch_presence_aware=true&presence_sub=trueStarts a Real Time Messaging session.
search
- GETsearch_messages
/search.messages?token=string&count=0&highlight=true&page=0&query=string&sort=string&sort_dir=stringSearches for messages matching a query.
stars
- POSTstars_add
/stars.addAdds a star to an item. - GETstars_list
/stars.list?token=string&count=string&page=string&cursor=string&limit=0Lists stars for a user. - POSTstars_remove
/stars.removeRemoves a star from an item.
team
- GETteam_accessLogs
/team.accessLogs?token=string&before=string&count=string&page=stringGets the access logs for the current team. - GETteam_billableInfo
/team.billableInfo?token=string&user=stringGets billable users information for the current team. - GETteam_info
/team.info?token=string&team=stringGets information about the current team. - GETteam_integrationLogs
/team.integrationLogs?token=string&app_id=string&change_type=string&count=string&page=string&service_id=string&user=stringGets the integration logs for the current team.
team.profile
- GETteam_profile_get
/team.profile.get?token=string&visibility=stringRetrieve a team's profile.
usergroups
- POSTusergroups_create
/usergroups.createCreate a User Group - POSTusergroups_disable
/usergroups.disableDisable an existing User Group - POSTusergroups_enable
/usergroups.enableEnable a User Group - GETusergroups_list
/usergroups.list?include_users=true&token=string&include_count=true&include_disabled=trueList all User Groups for a team - POSTusergroups_update
/usergroups.updateUpdate an existing User Group
usergroups.users
- GETusergroups_users_list
/usergroups.users.list?token=string&include_disabled=true&usergroup=stringList all users in a User Group - POSTusergroups_users_update
/usergroups.users.updateUpdate the list of users for a User Group
users
- GETusers_conversations
/users.conversations?token=string&user=string&types=string&exclude_archived=true&limit=0&cursor=stringList conversations the calling user may access. - POSTusers_deletePhoto
/users.deletePhotoDelete the user profile photo - GETusers_getPresence
/users.getPresence?token=string&user=stringGets user presence information. - GETusers_identity
/users.identity?token=stringGet a user's identity. - GETusers_info
/users.info?token=string&include_locale=true&user=stringGets information about a user. - GETusers_list
/users.list?token=string&limit=0&cursor=string&include_locale=trueLists all users in a Slack team. - GETusers_lookupByEmail
/users.lookupByEmail?token=string&email=stringFind a user with an email address. - POSTusers_setActive
/users.setActiveMarked a user as active. Deprecated and non-functional. - POSTusers_setPhoto
/users.setPhotoSet the user profile photo - POSTusers_setPresence
/users.setPresenceManually sets user presence.
users.profile
- GETusers_profile_get
/users.profile.get?token=string&include_labels=true&user=stringRetrieves a user's profile information. - POSTusers_profile_set
/users.profile.setSet the profile information for a user.
views
- GETviews_open
/views.open?trigger_id=string&view=stringOpen a view for a user. - GETviews_publish
/views.publish?user_id=string&view=string&hash=stringPublish a static view for a User. - GETviews_push
/views.push?trigger_id=string&view=stringPush a view onto the stack of a root view. - GETviews_update
/views.update?view_id=string&external_id=string&view=string&hash=stringUpdate an existing view.
workflows
- GETworkflows_stepCompleted
/workflows.stepCompleted?workflow_step_execute_id=string&outputs=stringIndicate that an app's step in a workflow completed execution. - GETworkflows_stepFailed
/workflows.stepFailed?workflow_step_execute_id=string&error=stringIndicate that an app's step in a workflow failed to execute. - GETworkflows_updateStep
/workflows.updateStep?workflow_step_edit_id=string&inputs=string&outputs=string&step_name=string&step_image_url=stringUpdate the configuration for a workflow extension step.
API details
- Base URL
https://slack.com/api- Authentication
- OAuth 2.0 (authorization code flow) with 67 scopes
- Operations
- 174 operations on 174 pathsPOST 94GET 80
- Main resources
- admin 56conversations 18admin.conversations 13files 13users 12chat 10admin.users 8apps 8usergroups 7admin.teams.settings 6
- Description format
- Swagger 2.0, API version
1.7.0 - Links
- Documentation · OpenAPI document · Support
- Listed from
- Slack's published OpenAPI description (slackapi/slack-api-specs) (MIT)
How to test the Slack Web API (all endpoints) in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Slack Web API (all endpoints) collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 67 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “admin_apps_approve” (POST /admin.apps.approve), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Slack Web API (all endpoints)?
One way to interact with the Slack platform is its HTTP RPC-based Web API, a collection of methods requiring OAuth 2.0-based user, bot, or workspace tokens… It is listed under Communication and has 174 endpoints.
Who publishes the Slack Web API (all endpoints)?
It is listed from Slack's public API description (an OpenAPI document), not published by Slack on Swastik Codes. Anyone who controls slack.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Slack Web API (all endpoints)?
Requests go to https://slack.com/api. Endpoint paths are added to this base URL.
How do I authenticate with the Slack Web API (all endpoints)?
With OAuth 2.0 (authorization code flow) with 67 scopes.
How many endpoints does the Slack Web API (all endpoints) have?
174 operations on 174 paths (94 POST, 80 GET). The largest groups are admin, conversations, admin.conversations, files.
Is forking the Slack Web API (all endpoints) free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.