Web API methods

Popular method groups
appsauthchatconversationsfilesreactionsremindersteamsusersusergroupsviews
admin.analytics.getFileRetrieve analytics data for a given date, presented as a compressed JSON file
admin.apps.activities.listGet logs for a specified team/org
admin.apps.approveApprove an app for installation on a workspace.
admin.apps.clearResolutionClear an app resolution
admin.apps.restrictRestrict an app for installation on a workspace.
admin.apps.uninstallUninstall an app from one or many workspaces, or an entire enterprise organization.
admin.apps.approved.listList approved apps for an org or workspace.
admin.apps.config.lookupLook up the app config for connectors by their IDs
admin.apps.config.setSet the app config for a connector
admin.apps.requests.cancelCancel app request for team
admin.apps.requests.listList app requests for a team/workspace.
admin.apps.restricted.listList restricted apps for an org or workspace.
admin.audit.anomaly.allow.getItemAPI to allow enterprise grid admins to read the allow list of IP blocks and ASNs from the enterprise configuration.
admin.audit.anomaly.allow.updateItemAPI to allow enterprise grid admins to write/overwrite the allow list of IP blocks and ASNs from the enterprise configuration.
admin.auth.policy.assignEntitiesAssign entities to a particular authentication policy.
admin.auth.policy.getEntitiesFetch all the entities assigned to a particular authentication policy by name.
admin.auth.policy.removeEntitiesRemove specified entities from a specified authentication policy.
admin.barriers.createCreate an Information Barrier
admin.barriers.deleteDelete an existing Information Barrier
admin.barriers.listGet all Information Barriers for your organization
admin.barriers.updateUpdate an existing Information Barrier
admin.conversations.archiveArchive a public or private channel.
admin.conversations.bulkArchiveArchive public or private channels in bulk.
admin.conversations.bulkDeleteDelete public or private channels in bulk
admin.conversations.bulkMoveMove public or private channels in bulk.
admin.conversations.convertToPrivateConvert a public channel to a private channel.
admin.conversations.convertToPublicConvert a private channel to a public channel.
admin.conversations.createCreate a public or private channel-based conversation.
admin.conversations.createForObjectsCreate a Salesforce channel for the corresponding object provided.
admin.conversations.deleteDelete a public or private channel.
admin.conversations.disconnectSharedDisconnect a connected channel from one or more workspaces.
admin.conversations.getConversationPrefsGet conversation preferences for a public or private channel.
admin.conversations.getCustomRetentionThis API endpoint can be used by any admin to get a conversation's retention policy.
admin.conversations.getTeamsGet all the workspaces a given public or private channel is connected to within this Enterprise org.
admin.conversations.inviteInvite a user to a public or private channel.
admin.conversations.linkObjectsLink a Salesforce record to a channel
admin.conversations.lookupReturns channels on the given team using the filters.
admin.conversations.removeCustomRetentionThis API endpoint can be used by any admin to remove a conversation's retention policy.
admin.conversations.renameRename a public or private channel.
admin.conversations.searchSearch for public or private channels in an Enterprise organization.
admin.conversations.setConversationPrefsSet the posting permissions for a public or private channel.
admin.conversations.setCustomRetentionThis API endpoint can be used by any admin to set a conversation's retention policy.
admin.conversations.setTeamsSet the workspaces in an Enterprise grid org that connect to a public or private channel.
admin.conversations.unarchiveUnarchive a public or private channel.
admin.conversations.unlinkObjectsUnlink a Salesforce record from a channel
admin.conversations.ekm.listOriginalConnectedChannelInfoList all disconnected channels—i.e., channels that were once connected to other workspaces and then disconnected—and the corresponding original channel IDs for key revocation with EKM.
admin.conversations.restrictAccess.addGroupAdd an allowlist of IDP groups for accessing a channel
admin.conversations.restrictAccess.listGroupsList all IDP Groups linked to a channel
admin.conversations.restrictAccess.removeGroupRemove a linked IDP group linked from a private channel
admin.emoji.addAdd an emoji.
admin.emoji.addAliasAdd an emoji alias.
admin.emoji.listList emoji for an Enterprise Grid organization.
admin.emoji.removeRemove an emoji across an Enterprise Grid organization
admin.emoji.renameRename an emoji.
admin.functions.listLook up functions by a set of apps
admin.functions.permissions.lookupLookup the visibility of multiple Slack functions and include the users if it is limited to particular named entities.
admin.functions.permissions.setSet the visibility of a Slack function and define the users or workspaces if it is set to named_entities
admin.inviteRequests.approveApprove a workspace invite request.
admin.inviteRequests.denyDeny a workspace invite request.
admin.inviteRequests.listList all pending workspace invite requests.
admin.inviteRequests.approved.listList all approved workspace invite requests.
admin.inviteRequests.denied.listList all denied workspace invite requests.
admin.roles.addAssignmentsAdds members to the specified role with the specified scopes
admin.roles.listAssignmentsLists assignments for all roles across entities. Options to scope results by any combination of roles or entities
admin.roles.removeAssignmentsRemoves a set of users from a role for the given scopes and entities
admin.teams.admins.listList all of the admins on a given workspace.
admin.teams.createCreate an Enterprise team.
admin.teams.listList all teams on an Enterprise organization
admin.teams.owners.listList all of the owners on a given workspace.
admin.teams.settings.infoFetch information about settings in a workspace
admin.teams.settings.setDefaultChannelsSet the default channels of a workspace.
admin.teams.settings.setDescriptionSet the description of a given workspace.
admin.teams.settings.setDiscoverabilityAn API method that allows admins to set the discoverability of a given workspace
admin.teams.settings.setIconSets the icon of a workspace.
admin.teams.settings.setNameSet the name of a given workspace.
admin.usergroups.addChannelsAdd up to one hundred default channels to an IDP group.
admin.usergroups.addTeamsAssociate one or more default workspaces with an organization-wide IDP group.
admin.usergroups.listChannelsList the channels linked to an org-level IDP group (user group).
admin.usergroups.removeChannelsRemove one or more default channels from an org-level IDP group (user group).
admin.users.assignAdd an Enterprise user to a workspace.
admin.users.inviteInvite a user to a workspace.
admin.users.listList users on a workspace
admin.users.removeRemove a user from a workspace.
admin.users.setAdminSet an existing regular user or owner to be a workspace admin.
admin.users.setExpirationSet an expiration for a guest user
admin.users.setOwnerSet an existing regular user or admin to be a workspace owner.
admin.users.setRegularSet an existing guest user, admin user, or owner to be a regular user.
admin.users.session.clearSettingsClear user-specific session settings—the session duration and what happens when the client closes—for a list of users.
admin.users.session.getSettingsGet user-specific session settings—the session duration and what happens when the client closes—given a list of users.
admin.users.session.invalidateRevoke a single session for a user. The user will be forced to login to Slack.
admin.users.session.listList active user sessions for an organization
admin.users.session.resetWipes all valid sessions on all devices for a given user
admin.users.session.resetBulkEnqueues an asynchronous job to wipe all valid sessions on all devices for a given list of users
admin.users.session.setSettingsConfigure the user-level session settings—the session duration and what happens when the client closes—for one or more users.
admin.users.unsupportedVersions.exportAsk Slackbot to send you an export listing all workspace members using unsupported software, presented as a zipped CSV file.
admin.workflows.collaborators.addAdd collaborators to workflows within the team or enterprise
admin.workflows.collaborators.removeRemove collaborators from workflows within the team or enterprise
admin.workflows.permissions.lookupLook up the permissions for a set of workflows
admin.workflows.searchSearch workflows within the team or enterprise
admin.workflows.unpublishUnpublish workflows within the team or enterprise
admin.workflows.triggers.types.permissions.lookuplist the permissions for using each trigger type
admin.workflows.triggers.types.permissions.setSet the permissions for using a trigger type

Usage guides

Easily access APIs with Bolt

Make API calls, and handle responses, with a couple of lines of code, using our Bolt framework.

Using the Web API

If you can't use Bolt, read our guide to hand-craft Web API usage into your app.