Version 1
Connector Overview: This page documents all 175 actions for the Slackconnector v1.
Admin API (56)
POST admin apps approve
/admin.apps.approve
Approve an app for installation on a workspace.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
The id of the app to approve. |
|
|
The id of the request to approve. |
|
|
N/A |
GET admin apps approved list
/admin.apps.approved.list
List approved apps for an org or workspace.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) Authentication token. Requires scope: admin.apps:read |
|
|
The maximum number of items to return. Must be between 1 - 1000 both inclusive. |
|
|
Set cursor to next_cursor returned by the previous call to list items in the next page |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET admin apps requests list
/admin.apps.requests.list
List app requests for a team/workspace.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) Authentication token. Requires scope: admin.apps:read |
|
|
The maximum number of items to return. Must be between 1 - 1000 both inclusive. |
|
|
Set cursor to next_cursor returned by the previous call to list items in the next page |
|
|
N/A |
|
|
N/A |
POST admin apps restrict
/admin.apps.restrict
Restrict an app for installation on a workspace.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
The id of the app to restrict. |
|
|
The id of the request to restrict. |
|
|
N/A |
GET admin apps restricted list
/admin.apps.restricted.list
List restricted apps for an org or workspace.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) Authentication token. Requires scope: admin.apps:read |
|
|
The maximum number of items to return. Must be between 1 - 1000 both inclusive. |
|
|
Set cursor to next_cursor returned by the previous call to list items in the next page |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST admin conversations archive
/admin.conversations.archive
Archive a public or private channel.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The channel to archive. |
POST admin conversations convert To Private
/admin.conversations.convertToPrivate
Convert a public channel to a private channel.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The channel to convert to private. |
POST admin conversations create
/admin.conversations.create
Create a public or private channel-based conversation.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
Name of the public or private channel to create. |
|
|
When true, creates a private channel instead of a public channel |
|
|
Description of the public or private channel to create. |
|
|
When true, the channel will be available org-wide. Note: if the channel is not org_wide=true, you must specify a team_id for this channel |
|
|
The workspace to create the channel in. Note: this argument is required unless you set org_wide=true. |
POST admin conversations delete
/admin.conversations.delete
Delete a public or private channel.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The channel to delete. |
POST admin conversations disconnect Shared
/admin.conversations.disconnectShared
Disconnect a connected channel from one or more workspaces.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The channel to be disconnected from some workspaces. |
|
|
The team to be removed from the channel. Currently only a single team id can be specified. |
GET admin conversations ekm list Original Connected Channel Info
/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.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) Authentication token. Requires scope: admin.conversations:read |
|
|
A comma-separated list of channels to filter to. |
|
|
A comma-separated list of the workspaces to which the channels you would like returned belong. |
|
|
The maximum number of items to return. Must be between 1 - 1000 both inclusive. |
|
|
Set cursor to next_cursor returned by the previous call to list items in the next page. |
|
|
N/A |
GET admin conversations get Conversation Prefs
/admin.conversations.getConversationPrefs
Get conversation preferences for a public or private channel.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The channel to get preferences for. |
|
|
(Required) Authentication token. Requires scope: admin.conversations:read |
|
|
N/A |
GET admin conversations get Teams
/admin.conversations.getTeams
Get all the workspaces a given public or private channel is connected to within this Enterprise org.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The channel to determine connected workspaces within the organization for. |
|
|
Set cursor to next_cursor returned by the previous call to list items in the next page |
|
|
The maximum number of items to return. Must be between 1 - 1000 both inclusive. |
|
|
(Required) Authentication token. Requires scope: admin.conversations:read |
|
|
N/A |
POST admin conversations invite
/admin.conversations.invite
Invite a user to a public or private channel.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The users to invite. |
|
|
The channel that the users will be invited to. |
POST admin conversations rename
/admin.conversations.rename
Rename a public or private channel.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The channel to rename. |
|
|
N/A |
POST admin conversations restrict Access add Group
/admin.conversations.restrictAccess.addGroup
Add an allowlist of IDP groups for accessing a channel
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
Authentication token. Requires scope: admin.conversations:write |
|
|
The IDP Group ID to be an allowlist for the private channel. |
|
|
The channel to link this group to. |
|
|
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. |
GET admin conversations restrict Access list Groups
/admin.conversations.restrictAccess.listGroups
List all IDP Groups linked to a channel
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) Authentication token. Requires scope: admin.conversations:read |
|
|
(Required) |
|
|
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. |
|
|
N/A |
POST admin conversations restrict Access remove Group
/admin.conversations.restrictAccess.removeGroup
Remove a linked IDP group linked from a private channel
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
Authentication token. Requires scope: admin.conversations:write |
|
|
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. |
|
|
The IDP Group ID to remove from the private channel. |
|
|
The channel to remove the linked group from. |
GET admin conversations search
/admin.conversations.search
Search for public or private channels in an Enterprise organization.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Comma separated string of team IDs, signifying the workspaces to search through. |
|
|
Name of the the channel to query by. |
|
|
Maximum number of items to be returned. Must be between 1 - 20 both inclusive. Default is 10. |
|
|
Set cursor to next_cursor returned by the previous call to list items in the next page. |
|
|
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. |
|
|
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 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) |
|
|
(Required) Authentication token. Requires scope: admin.conversations:read |
|
|
N/A |
POST admin conversations set Conversation Prefs
/admin.conversations.setConversationPrefs
Set the posting permissions for a public or private channel.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) Authentication token. Requires scope: admin.conversations:write |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The channel to set the prefs for |
|
|
The prefs for this channel in a stringified JSON format. |
POST admin conversations set Teams
/admin.conversations.setTeams
Set the workspaces in an Enterprise grid org that connect to a public or private channel.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
The encoded channel_id to add or remove to workspaces. |
|
|
The workspace to which the channel belongs. Omit this argument if the channel is a cross-workspace shared channel. |
|
|
A comma-separated list of workspaces to which the channel should be shared. Not required if the channel is being shared org-wide. |
|
|
True if channel has to be converted to an org channel |
POST admin conversations unarchive
/admin.conversations.unarchive
Unarchive a public or private channel.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The channel to unarchive. |
POST admin emoji add
/admin.emoji.add
Add an emoji.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Authentication token. Requires scope: admin.teams:write |
|
|
The name of the emoji to be removed. Colons (:myemoji:) around the value are not required, although they may be included. |
|
|
The URL of a file to use as an image for the emoji. Square images under 128KB and with transparent backgrounds work best. |
POST admin emoji add Alias
/admin.emoji.addAlias
Add an emoji alias.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Authentication token. Requires scope: admin.teams:write |
|
|
The name of the emoji to be aliased. Colons (:myemoji:) around the value are not required, although they may be included. |
|
|
The alias of the emoji. |
GET admin emoji list
/admin.emoji.list
List emoji for an Enterprise Grid organization.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) Authentication token. Requires scope: admin.teams:read |
|
|
Set cursor to next_cursor returned by the previous call to list items in the next page |
|
|
The maximum number of items to return. Must be between 1 - 1000 both inclusive. |
|
|
N/A |
POST admin emoji remove
/admin.emoji.remove
Remove an emoji across an Enterprise Grid organization
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Authentication token. Requires scope: admin.teams:write |
|
|
The name of the emoji to be removed. Colons (:myemoji:) around the value are not required, although they may be included. |
POST admin emoji rename
/admin.emoji.rename
Rename an emoji.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Authentication token. Requires scope: admin.teams:write |
|
|
The name of the emoji to be renamed. Colons (:myemoji:) around the value are not required, although they may be included. |
|
|
The new name of the emoji. |
POST admin invite Requests approve
/admin.inviteRequests.approve
Approve a workspace invite request.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
ID of the request to invite. |
|
|
ID for the workspace where the invite request was made. |
GET admin invite Requests approved list
/admin.inviteRequests.approved.list
List all approved workspace invite requests.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
ID for the workspace where the invite requests were made. |
|
|
Value of the next_cursor field sent as part of the previous API response |
|
|
The number of results that will be returned by the API on each invocation. Must be between 1 - 1000, both inclusive |
|
|
(Required) Authentication token. Requires scope: admin.invites:read |
|
|
N/A |
GET admin invite Requests denied list
/admin.inviteRequests.denied.list
List all denied workspace invite requests.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
ID for the workspace where the invite requests were made. |
|
|
Value of the next_cursor field sent as part of the previous api response |
|
|
The number of results that will be returned by the API on each invocation. Must be between 1 - 1000 both inclusive |
|
|
(Required) Authentication token. Requires scope: admin.invites:read |
|
|
N/A |
POST admin invite Requests deny
/admin.inviteRequests.deny
Deny a workspace invite request.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
ID of the request to invite. |
|
|
ID for the workspace where the invite request was made. |
GET admin invite Requests list
/admin.inviteRequests.list
List all pending workspace invite requests.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
ID for the workspace where the invite requests were made. |
|
|
Value of the next_cursor field sent as part of the previous API response |
|
|
The number of results that will be returned by the API on each invocation. Must be between 1 - 1000, both inclusive |
|
|
(Required) Authentication token. Requires scope: admin.invites:read |
|
|
N/A |
GET admin teams admins list
/admin.teams.admins.list
List all of the admins on a given workspace.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) Authentication token. Requires scope: admin.teams:read |
|
|
The maximum number of items to return. |
|
|
Set cursor to next_cursor returned by the previous call to list items in the next page. |
|
|
(Required) |
|
|
N/A |
POST admin teams create
/admin.teams.create
Create an Enterprise team.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
Team domain (for example, slacksoftballteam). |
|
|
Team name (for example, Slack Softball Team). |
|
|
Description for the team. |
|
|
Who can join the team. A team's discoverability can be open, closed, invite_only, or unlisted. |
GET admin teams list
/admin.teams.list
List all teams on an Enterprise organization
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The maximum number of items to return. Must be between 1 - 100 both inclusive. |
|
|
Set cursor to next_cursor returned by the previous call to list items in the next page. |
|
|
(Required) Authentication token. Requires scope: admin.teams:read |
|
|
N/A |
GET admin teams owners list
/admin.teams.owners.list
List all of the owners on a given workspace.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) Authentication token. Requires scope: admin.teams:read |
|
|
(Required) |
|
|
The maximum number of items to return. Must be between 1 - 1000 both inclusive. |
|
|
Set cursor to next_cursor returned by the previous call to list items in the next page. |
|
|
N/A |
GET admin teams settings info
/admin.teams.settings.info
Fetch information about settings in a workspace
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) |
|
|
(Required) Authentication token. Requires scope: admin.teams:read |
|
|
N/A |
POST admin teams settings set Default Channels
/admin.teams.settings.setDefaultChannels
Set the default channels of a workspace.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Authentication token. Requires scope: admin.teams:write |
|
|
ID for the workspace to set the default channel for. |
|
|
An array of channel IDs. |
POST admin teams settings set Description
/admin.teams.settings.setDescription
Set the description of a given workspace.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
ID for the workspace to set the description for. |
|
|
The new description for the workspace. |
POST admin teams settings set Discoverability
/admin.teams.settings.setDiscoverability
An API method that allows admins to set the discoverability of a given workspace
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The ID of the workspace to set discoverability on. |
|
|
This workspace's discovery setting. It must be set to one of open, invite_only, closed, or unlisted. |
POST admin teams settings set Icon
/admin.teams.settings.setIcon
Sets the icon of a workspace.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Authentication token. Requires scope: admin.teams:write |
|
|
Image URL for the icon |
|
|
ID for the workspace to set the icon for. |
POST admin teams settings set Name
/admin.teams.settings.setName
Set the name of a given workspace.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
ID for the workspace to set the name for. |
|
|
The new name of the workspace. |
POST admin usergroups add Channels
/admin.usergroups.addChannels
Add one or more default channels to an IDP group.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
ID of the IDP group to add default channels for. |
|
|
Comma separated string of channel IDs. |
|
|
The workspace to add default channels in. |
POST admin usergroups add Teams
/admin.usergroups.addTeams
Associate one or more default workspaces with an organization-wide IDP group.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
An encoded usergroup (IDP Group) ID. |
|
|
A comma separated list of encoded team (workspace) IDs. Each workspace MUST belong to the organization associated with the token. |
|
|
When true, this method automatically creates new workspace accounts for the IDP group members. |
GET admin usergroups list Channels
/admin.usergroups.listChannels
List the channels linked to an org-level IDP group (user group).
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) ID of the IDP group to list default channels for. |
|
|
ID of the the workspace. |
|
|
Flag to include or exclude the count of members per channel. |
|
|
(Required) Authentication token. Requires scope: admin.usergroups:read |
|
|
N/A |
POST admin usergroups remove Channels
/admin.usergroups.removeChannels
Remove one or more default channels from an org-level IDP group (user group).
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
ID of the IDP Group |
|
|
Comma-separated string of channel IDs |
POST admin users assign
/admin.users.assign
Add an Enterprise user to a workspace.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
The ID (T1234) of the workspace. |
|
|
The ID of the user to add to the workspace. |
|
|
True if user should be added to the workspace as a guest. |
|
|
True if user should be added to the workspace as a single-channel guest. |
|
|
Comma separated values of channel IDs to add user in the new workspace. |
POST admin users invite
/admin.users.invite
Invite a user to a workspace.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (9)
|
Option Name |
Description |
|---|---|
|
|
The ID (T1234) of the workspace. |
|
|
The email address of the person to invite. |
|
|
A comma-separated list of channel_ids for this user to join. At least one channel is required. |
|
|
An optional message to send to the user in the invite email. |
|
|
Full name of the user. |
|
|
Allow this invite to be resent in the future if a user has not signed up yet. (default: false) |
|
|
Is this user a multi-channel guest user? (default: false) |
|
|
Is this user a single channel guest user? (default: false) |
|
|
Timestamp when guest account should be disabled. Only include this timestamp if you are inviting a guest user and you want their account to expire on a certain date. |
GET admin users list
/admin.users.list
List users on a workspace
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The ID (T1234) of the workspace. |
|
|
Set cursor to next_cursor returned by the previous call to list items in the next page. |
|
|
Limit for how many users to be retrieved per page |
|
|
(Required) Authentication token. Requires scope: admin.users:read |
|
|
N/A |
POST admin users remove
/admin.users.remove
Remove a user from a workspace.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The ID (T1234) of the workspace. |
|
|
The ID of the user to remove. |
POST admin users session invalidate
/admin.users.session.invalidate
Invalidate a single session for a user by session_id
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
ID of the team that the session belongs to |
|
|
N/A |
POST admin users session reset
/admin.users.session.reset
Wipes all valid sessions on all devices for a given user
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
The ID of the user to wipe sessions for |
|
|
Only expire mobile sessions (default: false) |
|
|
Only expire web sessions (default: false) |
POST admin users set Admin
/admin.users.setAdmin
Set an existing guest, regular user, or owner to be an admin user.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The ID (T1234) of the workspace. |
|
|
The ID of the user to designate as an admin. |
POST admin users set Expiration
/admin.users.setExpiration
Set an expiration for a guest user
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
The ID (T1234) of the workspace. |
|
|
The ID of the user to set an expiration for. |
|
|
Timestamp when guest account should be disabled. |
POST admin users set Owner
/admin.users.setOwner
Set an existing guest, regular user, or admin user to be a workspace owner.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The ID (T1234) of the workspace. |
|
|
Id of the user to promote to owner. |
POST admin users set Regular
/admin.users.setRegular
Set an existing guest user, admin user, or owner to be a regular user.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The ID (T1234) of the workspace. |
|
|
The ID of the user to designate as a regular user. |
Download
GET Download Asset
x-oneteg-downloader-path-without-authorization
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
This toggle enables you to load file content as the step output. Supported formats include JSON, XML, YML/YAML, CSV, TXT, and other text-based file types. Note that images, PDF files, and other binary formats cannot be loaded. Additionally, there is a file size limit for this feature; please check the logs for details. |
|
|
Enable or disable following URL redirects. If it is enabled, it will follow the URL redirects. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Web API (118)
GET api test
/api.test
Checks API calling code.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Error response to return |
|
|
example property to return |
|
|
N/A |
GET apps event authorizations list
/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.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET apps permissions info
/apps.permissions.info
Returns list of permissions this app has on a team.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET apps permissions request
/apps.permissions.request
Allows an app to request additional scopes
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) A comma separated list of scopes to request for |
|
|
(Required) Token used to trigger the permissions API |
|
|
N/A |
GET apps permissions resources list
/apps.permissions.resources.list
Returns list of resource grants this app has on a team.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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 for more detail. |
|
|
The maximum number of items to return. |
|
|
N/A |
GET apps permissions scopes list
/apps.permissions.scopes.list
Returns list of scopes this app has on a team.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET apps permissions users list
/apps.permissions.users.list
Returns list of user grants and corresponding scopes this app has on a team.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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 for more detail. |
|
|
The maximum number of items to return. |
|
|
N/A |
GET apps permissions users request
/apps.permissions.users.request
Enables an app to trigger a permissions modal to grant an app access to a user access scope.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) A comma separated list of user scopes to request for |
|
|
(Required) Token used to trigger the request |
|
|
(Required) The user this scope is being requested for |
|
|
N/A |
GET apps uninstall
/apps.uninstall
Uninstalls your app from a workspace.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Issued when you created your application. |
|
|
Issued when you created your application. |
|
|
N/A |
GET auth revoke
/auth.revoke
Revokes a token.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Setting this parameter to 1 triggers a _testing mode_ where the specified token will not actually be revoked. |
|
|
N/A |
GET auth test
/auth.test
Checks authentication & identity.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET bots info
/bots.info
Gets information about a bot user.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Bot user to get info on |
|
|
N/A |
POST calls add
/calls.add
Registers a new Call.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (8)
|
Option Name |
Description |
|---|---|
|
|
An ID supplied by the 3rd-party Call provider. It must be unique across all Calls from that service. |
|
|
The URL required for a client to join the Call. |
|
|
An optional, human-readable ID supplied by the 3rd-party Call provider. If supplied, this ID will be displayed in the Call object. |
|
|
When supplied, available Slack clients will attempt to directly launch the 3rd-party Call with this URL. |
|
|
Call start time in UTC UNIX timestamp format |
|
|
The name of the Call. |
|
|
The valid Slack user ID of the user who created this Call. When this method is called with a user token, the created_by field is optional and defaults to the authed user of the token. Otherwise, the field is required. |
|
|
The list of users to register as participants in the Call. Read more on how to specify users here. |
POST calls end
/calls.end
Ends a Call.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
id returned when registering the call using the calls.add method. |
|
|
Call duration in seconds |
GET calls info
/calls.info
Returns information about a Call.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) id of the Call returned by the calls.add method. |
|
|
N/A |
POST calls participants add
/calls.participants.add
Registers new participants added to a Call.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
id returned by the calls.add method. |
|
|
The list of users to add as participants in the Call. Read more on how to specify users here. |
POST calls participants remove
/calls.participants.remove
Registers participants removed from a Call.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
id returned by the calls.add method. |
|
|
The list of users to remove as participants in the Call. Read more on how to specify users here. |
POST calls update
/calls.update
Updates information about a Call.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
id returned by the calls.add method. |
|
|
The name of the Call. |
|
|
The URL required for a client to join the Call. |
|
|
When supplied, available Slack clients will attempt to directly launch the 3rd-party Call with this URL. |
POST chat delete
/chat.delete
Deletes a message.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Timestamp of the message to be deleted. |
|
|
Channel containing the message to be deleted. |
|
|
Pass true to delete the message as the authed user with chat:write:user scope. Bot users in this context are considered authed users. If unused or false, the message will be deleted with chat:write:bot scope. |
POST chat delete Scheduled Message
/chat.deleteScheduledMessage
Deletes a pending scheduled message from the queue.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
The channel the scheduled_message is posting to |
|
|
scheduled_message_id returned from call to chat.scheduleMessage |
|
|
Pass true to delete the message as the authed user with chat:write:user scope. Bot users in this context are considered authed users. If unused or false, the message will be deleted with chat:write:bot scope. |
GET chat get Permalink
/chat.getPermalink
Retrieve a permalink URL for a specific extant message
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The ID of the conversation or channel containing the message |
|
|
(Required) A message's ts value, uniquely identifying it within a channel |
|
|
N/A |
POST chat me Message
/chat.meMessage
Share a me message into a channel.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Channel to send message to. Can be a public channel, private group or IM channel. Can be an encoded ID, or a name. |
|
|
Text of the message to send. |
POST chat post Ephemeral
/chat.postEphemeral
Sends an ephemeral message to a user in a channel.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (12)
|
Option Name |
Description |
|---|---|
|
|
Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name. |
|
|
id of the user who will receive the ephemeral message. The user should be in the channel specified by the channel argument. |
|
|
Pass true to post the message as the authed user. Defaults to true if the chat:write:bot scope is not included. Otherwise, defaults to false. |
|
|
A JSON-based array of structured attachments, presented as a URL-encoded string. |
|
|
A JSON-based array of structured blocks, presented as a URL-encoded string. |
|
|
Emoji to use as the icon for this message. Overrides icon_url. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below. |
|
|
URL to an image to use as the icon for this message. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below. |
|
|
Find and link channel names and usernames. |
|
|
Change how messages are treated. Defaults to none. See below. |
|
|
How this field works and whether it is required depends on other fields you use in your API call. See below for more detail. |
|
|
Provide another message's ts value to post this message in a thread. Avoid using a reply's ts value; use its parent's value instead. Ephemeral messages in threads are only shown if there is already an active thread. |
|
|
Set your bot's user name. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below. |
POST chat post Message
/chat.postMessage
Sends a message to a channel.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (15)
|
Option Name |
Description |
|---|---|
|
|
Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name. See below for more details. |
|
|
Pass true to post the message as the authed user, instead of as a bot. Defaults to false. See authorship below. |
|
|
A JSON-based array of structured attachments, presented as a URL-encoded string. |
|
|
A JSON-based array of structured blocks, presented as a URL-encoded string. |
|
|
Emoji to use as the icon for this message. Overrides icon_url. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below. |
|
|
URL to an image to use as the icon for this message. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below. |
|
|
Find and link channel names and usernames. |
|
|
Disable Slack markup parsing by setting to false. Enabled by default. |
|
|
Change how messages are treated. Defaults to none. See below. |
|
|
Used in conjunction with thread_ts and indicates whether reply should be made visible to everyone in the channel or conversation. Defaults to false. |
|
|
How this field works and whether it is required depends on other fields you use in your API call. See below for more detail. |
|
|
Provide another message's ts value to make this message a reply. Avoid using a reply's ts value; use its parent instead. |
|
|
Pass true to enable unfurling of primarily text-based content. |
|
|
Pass false to disable unfurling of media content. |
|
|
Set your bot's user name. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below. |
POST chat schedule Message
/chat.scheduleMessage
Schedules a message to be sent to a channel.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (12)
|
Option Name |
Description |
|---|---|
|
|
Channel, private group, or DM channel to send message to. Can be an encoded ID, or a name. See below for more details. |
|
|
How this field works and whether it is required depends on other fields you use in your API call. See below for more detail. |
|
|
Unix EPOCH timestamp of time in future to send the message. |
|
|
Change how messages are treated. Defaults to none. See chat.postMessage. |
|
|
Pass true to post the message as the authed user, instead of as a bot. Defaults to false. See chat.postMessage. |
|
|
Find and link channel names and usernames. |
|
|
A JSON-based array of structured attachments, presented as a URL-encoded string. |
|
|
A JSON-based array of structured blocks, presented as a URL-encoded string. |
|
|
Pass true to enable unfurling of primarily text-based content. |
|
|
Pass false to disable unfurling of media content. |
|
|
Provide another message's ts value to make this message a reply. Avoid using a reply's ts value; use its parent instead. |
|
|
Used in conjunction with thread_ts and indicates whether reply should be made visible to everyone in the channel or conversation. Defaults to false. |
GET chat scheduled Messages list
/chat.scheduledMessages.list
Returns a list of scheduled messages.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The channel of the scheduled messages |
|
|
A UNIX timestamp of the latest value in the time range |
|
|
A UNIX timestamp of the oldest value in the time range |
|
|
Maximum number of original entries to return. |
|
|
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. |
|
|
N/A |
POST chat unfurl
/chat.unfurl
Provide custom unfurl behavior for user-posted URLs
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
Channel ID of the message |
|
|
Timestamp of the message to add unfurl behavior to. |
|
|
URL-encoded JSON map with keys set to URLs featured in the the message, pointing to their unfurl blocks or message attachments. |
|
|
Provide a simply-formatted string to send as an ephemeral message to the user as invitation to authenticate further and enable full unfurling behavior |
|
|
Set to true or 1 to indicate the user must install your Slack app to trigger unfurls for this domain |
|
|
Send users to this custom URL where they will complete authentication in your app to fully trigger unfurling. Value should be properly URL-encoded. |
POST chat update
/chat.update
Updates a message.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (8)
|
Option Name |
Description |
|---|---|
|
|
Channel containing the message to be updated. |
|
|
Timestamp of the message to be updated. |
|
|
Pass true to update the message as the authed user. Bot users in this context are considered authed users. |
|
|
A JSON-based array of structured attachments, presented as a URL-encoded string. This field is required when not presenting text. If you don't include this field, the message's previous attachments will be retained. To remove previous attachments, include an empty array for this field. |
|
|
A JSON-based array of structured blocks, presented as a URL-encoded string. If you don't include this field, the message's previous blocks will be retained. To remove previous blocks, include an empty array for this field. |
|
|
Find and link channel names and usernames. Defaults to none. If you do not specify a value for this field, the original value set for the message will be overwritten with the default, none. |
|
|
Change how messages are treated. Defaults to client, unlike chat.postMessage. Accepts either none or full. If you do not specify a value for this field, the original value set for the message will be overwritten with the default, client. |
|
|
New text for the message, using the default formatting rules. It's not required when presenting blocks or attachments. |
POST conversations archive
/conversations.archive
Archives a conversation.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
ID of conversation to archive |
POST conversations close
/conversations.close
Closes a direct message or multi-person direct message.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Conversation to close. |
POST conversations create
/conversations.create
Initiates a public or private channel-based conversation
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Name of the public or private channel to create |
|
|
Create a private channel instead of a public one |
GET conversations history
/conversations.history
Fetches a conversation's history of messages and events.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Conversation ID to fetch history for. |
|
|
End of time range of messages to include in results. |
|
|
Start of time range of messages to include in results. |
|
|
Include messages with latest or oldest timestamp in results only when either timestamp is specified. |
|
|
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. |
|
|
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 for more detail. |
|
|
N/A |
GET conversations info
/conversations.info
Retrieve information about a conversation.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Conversation ID to learn more about |
|
|
Set this to true to receive the locale for this conversation. Defaults to false |
|
|
Set to true to include the member count for the specified conversation. Defaults to false |
|
|
N/A |
POST conversations invite
/conversations.invite
Invites users to a channel.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The ID of the public or private channel to invite user(s) to. |
|
|
A comma separated list of user IDs. Up to 1000 users may be listed. |
POST conversations join
/conversations.join
Joins an existing conversation.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
ID of conversation to join |
POST conversations kick
/conversations.kick
Removes a user from a conversation.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
ID of conversation to remove user from. |
|
|
User ID to be removed. |
POST conversations leave
/conversations.leave
Leaves a conversation.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Conversation to leave |
GET conversations list
/conversations.list
Lists all channels in a Slack team.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Set to true to exclude archived channels from the list |
|
|
Mix and match channel types by providing a comma-separated list of any combination of public_channel, private_channel, mpim, im |
|
|
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. |
|
|
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 for more detail. |
|
|
N/A |
POST conversations mark
/conversations.mark
Sets the read cursor in a channel.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Channel or conversation to set the read cursor for. |
|
|
Unique identifier of message you want marked as most recently seen in this conversation. |
GET conversations members
/conversations.members
Retrieve members of a conversation.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
ID of the conversation to retrieve members for |
|
|
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. |
|
|
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 for more detail. |
|
|
N/A |
POST conversations open
/conversations.open
Opens or resumes a direct message or multi-person direct message.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Resume a conversation by supplying an im or mpim's ID. Or provide the users field instead. |
|
|
Comma separated lists of users. If only one user is included, this creates a 1:1 DM. The ordering of the users is preserved whenever a multi-person direct message is returned. Supply a channel when not supplying users. |
|
|
Boolean, indicates you want the full IM channel definition in the response. |
POST conversations rename
/conversations.rename
Renames a conversation.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
ID of conversation to rename |
|
|
New name for conversation. |
GET conversations replies
/conversations.replies
Retrieve a thread of messages posted to a conversation
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Conversation ID to fetch thread from. |
|
|
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. |
|
|
End of time range of messages to include in results. |
|
|
Start of time range of messages to include in results. |
|
|
Include messages with latest or oldest timestamp in results only when either timestamp is specified. |
|
|
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. |
|
|
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 for more detail. |
|
|
N/A |
POST conversations set Purpose
/conversations.setPurpose
Sets the purpose for a conversation.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Conversation to set the purpose of |
|
|
A new, specialer purpose |
POST conversations set Topic
/conversations.setTopic
Sets the topic for a conversation.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Conversation to set the topic of |
|
|
The new topic string. Does not support formatting or linkification. |
POST conversations unarchive
/conversations.unarchive
Reverses conversation archival.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
ID of conversation to unarchive |
GET dialog open
/dialog.open
Open a dialog with a user
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The dialog definition. This must be a JSON-encoded string. |
|
|
(Required) Exchange a trigger to post to the user. |
|
|
N/A |
POST dnd end Dnd
/dnd.endDnd
Ends the current user's Do Not Disturb session immediately.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST dnd end Snooze
/dnd.endSnooze
Ends the current user's snooze mode immediately.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET dnd info
/dnd.info
Retrieves a user's current Do Not Disturb status.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
User to fetch status for (defaults to current user) |
|
|
N/A |
POST dnd set Snooze
/dnd.setSnooze
Turns on Do Not Disturb mode for the current user, or changes its duration.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Authentication token. Requires scope: dnd:write |
|
|
Number of minutes, from now, to snooze until. |
GET dnd team Info
/dnd.teamInfo
Retrieves the Do Not Disturb status for up to 50 users on a team.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Comma-separated list of users to fetch Do Not Disturb status for |
|
|
N/A |
GET emoji list
/emoji.list
Lists custom emoji for a team.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST files comments delete
/files.comments.delete
Deletes an existing comment on a file.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
File to delete a comment from. |
|
|
The comment to delete. |
POST files delete
/files.delete
Deletes a file.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
ID of file to delete. |
GET files info
/files.info
Gets information about a file.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Specify a file by providing its ID. |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
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 for more details. |
|
|
N/A |
GET files list
/files.list
List for a team, in a channel, or from a user with applied filters.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filter files created by a single user. |
|
|
Filter files appearing in a specific channel, indicated by its ID. |
|
|
Filter files created after this timestamp (inclusive). |
|
|
Filter files created before this timestamp (inclusive). |
|
|
Filter files by type (see below). You can pass multiple values in the types argument, like types=spaces,snippets.The default value is all, which does not filter the list. |
|
|
N/A |
|
|
N/A |
|
|
Show truncated file info for files hidden due to being too old, and the team who owns the file being over the file limit. |
|
|
N/A |
POST files remote add
/files.remote.add
Adds a file from a remote service
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (7)
|
Option Name |
Description |
|---|---|
|
|
Authentication token. Requires scope: remote_files:write |
|
|
Creator defined GUID for the file. |
|
|
Title of the file being shared. |
|
|
type of file |
|
|
URL of the remote file. |
|
|
Preview of the document via multipart/form-data. |
|
|
A text file (txt, pdf, doc, etc.) containing textual search terms that are used to improve discovery of the remote file. |
GET files remote info
/files.remote.info
Retrieve information about a remote file added to Slack
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Specify a file by providing its ID. |
|
|
Creator defined GUID for the file. |
|
|
N/A |
GET files remote list
/files.remote.list
Retrieve information about a remote file added to Slack
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filter files appearing in a specific channel, indicated by its ID. |
|
|
Filter files created after this timestamp (inclusive). |
|
|
Filter files created before this timestamp (inclusive). |
|
|
The maximum number of items to return. |
|
|
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 for more detail. |
|
|
N/A |
POST files remote remove
/files.remote.remove
Remove a remote file.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Authentication token. Requires scope: remote_files:write |
|
|
Specify a file by providing its ID. |
|
|
Creator defined GUID for the file. |
GET files remote share
/files.remote.share
Share a remote file into a channel.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Specify a file registered with Slack by providing its ID. Either this field or external_id or both are required. |
|
|
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. |
|
|
Comma-separated list of channel IDs where the file will be shared. |
|
|
N/A |
POST files remote update
/files.remote.update
Updates an existing remote file.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (8)
|
Option Name |
Description |
|---|---|
|
|
Authentication token. Requires scope: remote_files:write |
|
|
Specify a file by providing its ID. |
|
|
Creator defined GUID for the file. |
|
|
Title of the file being shared. |
|
|
type of file |
|
|
URL of the remote file. |
|
|
Preview of the document via multipart/form-data. |
|
|
File containing contents that can be used to improve searchability for the remote file. |
POST files revoke Public URL
/files.revokePublicURL
Revokes public/external sharing access for a file
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
File to revoke |
POST files shared Public URL
/files.sharedPublicURL
Enables a file for public/external sharing.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
File to share |
POST files upload
/files.upload
Uploads or creates a file.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (8)
|
Option Name |
Description |
|---|---|
|
|
File contents via multipart/form-data. If omitting this parameter, you must submit content. |
|
|
File contents via a POST variable. If omitting this parameter, you must provide a file. |
|
|
A file type identifier. |
|
|
Filename of file. |
|
|
Title of file. |
|
|
The message text introducing the file in specified channels. |
|
|
Comma-separated list of channel names or IDs where the file will be shared. |
|
|
Provide another message's ts value to upload this file as a reply. Never use a reply's ts value; use its parent instead. |
GET migration exchange
/migration.exchange
For Enterprise Grid workspaces, map local user IDs to global user IDs
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) A comma-separated list of user ids, up to 400 per request |
|
|
Specify team_id starts with T in case of Org Token |
|
|
Specify true to convert W global user IDs to workspace-specific U IDs. Defaults to false. |
|
|
N/A |
GET oauth access
/oauth.access
Exchanges a temporary OAuth verifier code for an access token.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Issued when you created your application. |
|
|
Issued when you created your application. |
|
|
The code param returned via the OAuth callback. |
|
|
This must match the originally submitted URI (if one was sent). |
|
|
Request the user to add your app only to a single channel. Only valid with a legacy workspace app. |
|
|
N/A |
GET oauth token
/oauth.token
Exchanges a temporary OAuth verifier code for a workspace token.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Issued when you created your application. |
|
|
Issued when you created your application. |
|
|
The code param returned via the OAuth callback. |
|
|
This must match the originally submitted URI (if one was sent). |
|
|
Request the user to add your app only to a single channel. |
|
|
N/A |
GET oauth v2 access
/oauth.v2.access
Exchanges a temporary OAuth verifier code for an access token.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Issued when you created your application. |
|
|
Issued when you created your application. |
|
|
(Required) The code param returned via the OAuth callback. |
|
|
This must match the originally submitted URI (if one was sent). |
|
|
N/A |
POST pins add
/pins.add
Pins an item to a channel.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Channel to pin the item in. |
|
|
Timestamp of the message to pin. |
GET pins list
/pins.list
Lists items pinned to a channel.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) Channel to get pinned items for. |
|
|
N/A |
POST pins remove
/pins.remove
Un-pins an item from a channel.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Channel where the item is pinned to. |
|
|
Timestamp of the message to un-pin. |
POST reactions add
/reactions.add
Adds a reaction to an item.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Channel where the message to add reaction to was posted. |
|
|
Reaction (emoji) name. |
|
|
Timestamp of the message to add reaction to. |
GET reactions get
/reactions.get
Gets reactions for an item.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Channel where the message to get reactions for was posted. |
|
|
File to get reactions for. |
|
|
File comment to get reactions for. |
|
|
If true always return the complete reaction list. |
|
|
Timestamp of the message to get reactions for. |
|
|
N/A |
GET reactions list
/reactions.list
Lists reactions made by a user.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Show reactions made by this user. Defaults to the authed user. |
|
|
If true always return the complete reaction list. |
|
|
N/A |
|
|
N/A |
|
|
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 for more details. |
|
|
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. |
|
|
N/A |
POST reactions remove
/reactions.remove
Removes a reaction from an item.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
Reaction (emoji) name. |
|
|
File to remove reaction from. |
|
|
File comment to remove reaction from. |
|
|
Channel where the message to remove reaction from was posted. |
|
|
Timestamp of the message to remove reaction from. |
POST reminders add
/reminders.add
Creates a reminder.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
The content of the reminder |
|
|
When this reminder should happen: the Unix timestamp (up to five years from now), the number of seconds until the reminder (if within 24 hours), or a natural language description (Ex. "in 15 minutes," or "every Thursday") |
|
|
The user who will receive the reminder. If no user is specified, the reminder will go to user who created it. |
POST reminders complete
/reminders.complete
Marks a reminder as complete.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The ID of the reminder to be marked as complete |
POST reminders delete
/reminders.delete
Deletes a reminder.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The ID of the reminder |
GET reminders info
/reminders.info
Gets information about a reminder.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the reminder |
|
|
N/A |
GET reminders list
/reminders.list
Lists all reminders created by or for a given user.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET rtm connect
/rtm.connect
Starts a Real Time Messaging session.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Batch presence deliveries via subscription. Enabling changes the shape of presence_change events. See batch presence. |
|
|
Only deliver presence events when requested by subscription. See presence subscriptions. |
|
|
N/A |
GET search messages
/search.messages
Searches for messages matching a query.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Pass the number of results you want per "page". Maximum of 100. |
|
|
Pass a value of true to enable query highlight markers (see below). |
|
|
N/A |
|
|
(Required) Search query. |
|
|
Return matches sorted by either score or timestamp. |
|
|
Change sort direction to ascending (asc) or descending (desc). |
|
|
N/A |
POST stars add
/stars.add
Adds a star to an item.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
Channel to add star to, or channel where the message to add star to was posted (used with timestamp). |
|
|
File to add star to. |
|
|
File comment to add star to. |
|
|
Timestamp of the message to add star to. |
GET stars list
/stars.list
Lists stars for a user.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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 for more details. |
|
|
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. |
|
|
N/A |
POST stars remove
/stars.remove
Removes a star from an item.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
Channel to remove star from, or channel where the message to remove star from was posted (used with timestamp). |
|
|
File to remove star from. |
|
|
File comment to remove star from. |
|
|
Timestamp of the message to remove star from. |
GET team access Logs
/team.accessLogs
Gets the access logs for the current team.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
End of time range of logs to include in results (inclusive). |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET team billable Info
/team.billableInfo
Gets billable users information for the current team.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
A user to retrieve the billable information for. Defaults to all users. |
|
|
N/A |
GET team info
/team.info
Gets information about the current team.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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 |
|
|
N/A |
GET team integration Logs
/team.integrationLogs
Gets the integration logs for the current team.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filter logs to this Slack app. Defaults to all logs. |
|
|
Filter logs with this change type. Defaults to all logs. |
|
|
N/A |
|
|
N/A |
|
|
Filter logs to this service. Defaults to all logs. |
|
|
Filter logs generated by this user’s actions. Defaults to all logs. |
|
|
N/A |
GET team profile get
/team.profile.get
Retrieve a team's profile.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filter by visibility. |
|
|
N/A |
POST usergroups create
/usergroups.create
Create a User Group
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
A name for the User Group. Must be unique among User Groups. |
|
|
A comma separated string of encoded channel IDs for which the User Group uses as a default. |
|
|
A short description of the User Group. |
|
|
A mention handle. Must be unique among channels, users and User Groups. |
|
|
Include the number of users in each User Group. |
POST usergroups disable
/usergroups.disable
Disable an existing User Group
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The encoded ID of the User Group to disable. |
|
|
Include the number of users in the User Group. |
POST usergroups enable
/usergroups.enable
Enable a User Group
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The encoded ID of the User Group to enable. |
|
|
Include the number of users in the User Group. |
GET usergroups list
/usergroups.list
List all User Groups for a team
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Include the list of users for each User Group. |
|
|
Include the number of users in each User Group. |
|
|
Include disabled User Groups. |
|
|
N/A |
POST usergroups update
/usergroups.update
Update an existing User Group
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The encoded ID of the User Group to update. |
|
|
A mention handle. Must be unique among channels, users and User Groups. |
|
|
A short description of the User Group. |
|
|
A comma separated string of encoded channel IDs for which the User Group uses as a default. |
|
|
Include the number of users in the User Group. |
|
|
A name for the User Group. Must be unique among User Groups. |
GET usergroups users list
/usergroups.users.list
List all users in a User Group
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Allow results that involve disabled User Groups. |
|
|
(Required) The encoded ID of the User Group to update. |
|
|
N/A |
POST usergroups users update
/usergroups.users.update
Update the list of users for a User Group
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
The encoded ID of the User Group to update. |
|
|
A comma separated string of encoded user IDs that represent the entire list of users for the User Group. |
|
|
Include the number of users in the User Group. |
GET users conversations
/users.conversations
List conversations the calling user may access.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Browse conversations by a specific user ID's membership. Non-public channels are restricted to those where the calling user shares membership. |
|
|
Mix and match channel types by providing a comma-separated list of any combination of public_channel, private_channel, mpim, im |
|
|
Set to true to exclude archived channels from the list |
|
|
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. |
|
|
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 for more detail. |
|
|
N/A |
POST users delete Photo
/users.deletePhoto
Delete the user profile photo
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET users get Presence
/users.getPresence
Gets user presence information.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
User to get presence info on. Defaults to the authed user. |
|
|
N/A |
GET users identity
/users.identity
Get a user's identity.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET users info
/users.info
Gets information about a user.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Set this to true to receive the locale for this user. Defaults to false |
|
|
User to get info on |
|
|
N/A |
GET users list
/users.list
Lists all users in a Slack team.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
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 for more detail. |
|
|
Set this to true to receive the locale for users. Defaults to false |
|
|
N/A |
GET users lookup By Email
/users.lookupByEmail
Find a user with an email address.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) An email address belonging to a user in the workspace |
|
|
N/A |
GET users profile get
/users.profile.get
Retrieves a user's profile information.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Include labels for each ID in custom profile fields |
|
|
User to retrieve profile info for |
|
|
N/A |
POST users profile set
/users.profile.set
Set the profile information for a user.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
Name of a single key to set. Usable only if profile is not passed. |
|
|
Collection of key:value pairs presented as a URL-encoded JSON hash. At most 50 fields may be set. Each field name is limited to 255 characters. |
|
|
ID of user to change. This argument may only be specified by team admins on paid teams. |
|
|
Value to set a single key to. Usable only if profile is not passed. |
POST users set Active
/users.setActive
Marked a user as active. Deprecated and non-functional.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST users set Photo
/users.setPhoto
Set the user profile photo
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
Width/height of crop box (always square) |
|
|
X coordinate of top-left corner of crop box |
|
|
Y coordinate of top-left corner of crop box |
|
|
File contents via multipart/form-data. |
POST users set Presence
/users.setPresence
Manually sets user presence.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Either auto or away |
GET views open
/views.open
Open a view for a user.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) Exchange a trigger to post to the user. |
|
|
(Required) A view payload. This must be a JSON-encoded string. |
|
|
N/A |
GET views publish
/views.publish
Publish a static view for a User.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) id of the user you want publish a view to. |
|
|
(Required) A view payload. This must be a JSON-encoded string. |
|
|
A string that represents view state to protect against possible race conditions. |
|
|
N/A |
GET views push
/views.push
Push a view onto the stack of a root view.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) Exchange a trigger to post to the user. |
|
|
(Required) A view payload. This must be a JSON-encoded string. |
|
|
N/A |
GET views update
/views.update
Update an existing view.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
A unique identifier of the view to be updated. Either view_id or external_id is required. |
|
|
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. |
|
|
A view object. This must be a JSON-encoded string. |
|
|
A string that represents view state to protect against possible race conditions. |
|
|
N/A |
GET workflows step Completed
/workflows.stepCompleted
Indicate that an app's step in a workflow completed execution.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) Context identifier that maps to the correct workflow step execution. |
|
|
Key-value object of outputs from your step. Keys of this object reflect the configured key properties of your outputs array from your workflow_step object. |
|
|
N/A |
GET workflows step Failed
/workflows.stepFailed
Indicate that an app's step in a workflow failed to execute.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) Context identifier that maps to the correct workflow step execution. |
|
|
(Required) A JSON-based object with a message property that should contain a human readable error message. |
|
|
N/A |
GET workflows update Step
/workflows.updateStep
Update the configuration for a workflow extension step.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) A context identifier provided with view_submission payloads used to call back to workflows.updateStep. |
|
|
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. |
|
|
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. |
|
|
An optional field that can be used to override the step name that is shown in the Workflow Builder. |
|
|
An optional field that can be used to override app image that is shown in the Workflow Builder. |
|
|
N/A |