• Installs:
  • Today: 112
  • This Week: 535
  • This Month: 2056
  • All Time: 311801
Developer:userdimashirokov

Slack API Package

Build tools, bots or apps for this communication tool.

List of Endpoints
This is the list of endpoints this API includes. To add of the endpoints to your app, please click on “Connect to endpoint” text.
See All
List of Webhook Events
This is the list of webhook events this API provides. Webhooks allow you to register to certain events and receive real-time data over websockets.
See All
Discussions
See All
Readme

Slack

Slack Package

This block can be used alone or in conjunction with each other to build many different kinds of Slack apps..

  • Domain: slack.com
  • Credentials: token

How to get credentials:

Test oauth token: https://api.slack.com/docs/oauth-test-tokens Slack oauth docomentation: https://api.slack.com/docs/oauth

TOC:

<a name="revokeAuth"/>

Slack.revokeAuth

This method revokes an access token. Use it when you no longer need a token. For example, with a Sign In With Slack app, call this to log a user out.

FieldTypeDescription
tokenStringAuthentication token
testNumberSetting this parameter to 1 triggers a testing mode where the specified token will not actually be revoked.

<a name="testAuth"/>

Slack.testAuth

This method checks authentication and tells you who you are.

FieldTypeDescription
tokenStringAuthentication token

<a name="getBotInfo"/>

Slack.getBotInfo

This method returns information about a bot user.

FieldTypeDescription
tokenStringAuthentication token
botStringBot user to get info on.

<a name="getChannels"/>

Slack.getChannels

This method returns a list of all channels in the team. This includes channels the caller is in, channels they are not currently in, and archived channels but does not include private channels. The number of (non-deactivated) members in each channel is also returned.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: channels:write)
excludeArchivedNumberDon't return archived channels.

<a name="createChannel"/>

Slack.createChannel

This method is used to create a channel.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: channels:write)
nameStringName of channel to create.

<a name="archiveChannel"/>

Slack.archiveChannel

This method archives a channel.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: channels:write)
channelStringChannel to archive.

<a name="getChannelHistory"/>

Slack.getChannelHistory

This method returns a portion of message events from the specified channel.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: channels:write)
channelStringChannel to fetch.
latestStringEnd of time range of messages to include in results.
oldestStringStart of time range of messages to include in results.
inclusiveNumberInclude messages with latest or oldest timestamp in results.
countNumberNumber of messages to return, between 1 and 1000.
unreadsStringInclude unread_count_display in the output?

<a name="getChannelInfo"/>

Slack.getChannelInfo

This method returns information about a team channel.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: channels:write)
channelStringChannel to get info on.

<a name="inviteToChannel"/>

Slack.inviteToChannel

This method is used to invite a user to a channel. The calling user must be a member of the channel.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: channels:write)
channelStringChannel to get info on.
userStringUser to invite to channel.

<a name="joinChannel"/>

Slack.joinChannel

This method is used to join a channel. If the channel does not exist, it is created.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: channels:write)
nameStringName of channel to join.

<a name="kickFromChannel"/>

Slack.kickFromChannel

This method allows a user to remove another member from a team channel.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: channels:write)
channelStringChannel to remove user from.
userStringUser to remove from channel.

<a name="leaveChannel"/>

Slack.leaveChannel

This method is used to leave a channel.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: channels:write)
channelStringChannel to leave.

<a name="markChannel"/>

Slack.markChannel

This method moves the read cursor in a channel.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: channels:write)
channelStringChannel to set reading cursor in.
tsStringTimestamp of the most recently seen message.

<a name="renameChannel"/>

Slack.renameChannel

This method renames a team channel.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: channels:write)
channelStringChannel to set reading cursor in.
nameStringNew name for channel.

<a name="setChannelPurpose"/>

Slack.setChannelPurpose

This method is used to change the purpose of a channel. The calling user must be a member of the channel.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: channels:write)
channelStringChannel to set reading cursor in.
purposeStringThe new purpose.

<a name="setChannelTopic"/>

Slack.setChannelTopic

This method is used to change the topic of a channel. The calling user must be a member of the channel.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: channels:write)
channelStringChannel to set reading cursor in.
topicStringThe new topic.

<a name="unarchiveChannel"/>

Slack.unarchiveChannel

This method unarchives a channel. The calling user is added to the channel.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: channels:write)
channelStringChannel to unarchive.

<a name="getPrivateChannels"/>

Slack.getPrivateChannels

This method returns a list of private channels in the team that the caller is in and archived groups that the caller was in. The list of (non-deactivated) members in each private channel is also returned.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: channels:write)
excludeArchivedNumberDon't return archived PrivateChannels.

<a name="createPrivateChannel"/>

Slack.createPrivateChannel

This method creates a private channel.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: channels:write)
nameStringName of PrivateChannel to create.

<a name="archivePrivateChannel"/>

Slack.archivePrivateChannel

This method archives a channel.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: channels:write)
channelStringPrivateChannel to archive.

<a name="getPrivateChannelHistory"/>

Slack.getPrivateChannelHistory

This method returns a portion of messages/events from the specified private channel. To read the entire history for a private channel, call the method with no latest or oldest arguments, and then continue paging using the instructions below.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: channels:write)
channelStringPrivate Channel to fetch.
latestStringEnd of time range of messages to include in results.
oldestStringStart of time range of messages to include in results.
inclusiveNumberInclude messages with latest or oldest timestamp in results.
countNumberNumber of messages to return, between 1 and 1000.
unreadsStringInclude unread_count_display in the output?

<a name="getPrivateChannelInfo"/>

Slack.getPrivateChannelInfo

This method returns information about a private channel.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: channels:write)
channelStringPrivateChannel to get info on.

<a name="inviteToPrivateChannel"/>

Slack.inviteToPrivateChannel

This method is used to invite a user to a private channel. The calling user must be a member of the private channel.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: channels:write)
channelStringPrivateChannel to get info on.
userStringUser to invite to PrivateChannel.

<a name="kickFromPrivateChannel"/>

Slack.kickFromPrivateChannel

This method allows a user to remove another member from a private channel.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: channels:write)
channelStringPrivateChannel to remove user from.
userStringUser to remove from PrivateChannel.

<a name="leavePrivateChannel"/>

Slack.leavePrivateChannel

This method is used to leave a channel.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: channels:write)
channelStringPrivateChannel to leave.

<a name="markPrivateChannel"/>

Slack.markPrivateChannel

This method moves the read cursor in a private channel.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: channels:write)
channelStringPrivateChannel to set reading cursor in.
tsStringTimestamp of the most recently seen message.

<a name="renamePrivateChannel"/>

Slack.renamePrivateChannel

This method renames a private channel.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: channels:write)
channelStringPrivateChannel to set reading cursor in.
nameStringNew name for PrivateChannel.

<a name="setPrivateChannelPurpose"/>

Slack.setPrivateChannelPurpose

This method is used to change the purpose of a private channel. The calling user must be a member of the private channel.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: channels:write)
channelStringPrivateChannel to set reading cursor in.
purposeStringThe new purpose.

<a name="setPrivateChannelTopic"/>

Slack.setPrivateChannelTopic

This method is used to change the topic of a private channel. The calling user must be a member of the private channel.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: channels:write)
channelStringPrivateChannel to set reading cursor in.
topicStringThe new topic.

<a name="unarchivePrivateChannel"/>

Slack.unarchivePrivateChannel

This method unarchives a private channel.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: channels:write)
channelStringPrivateChannel to unarchive.

<a name="openPrivateChannel"/>

Slack.openPrivateChannel

This method opens a private channel.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: channels:write)
channelStringPrivateChannel to open.

<a name="closePrivateChannel"/>

Slack.closePrivateChannel

This method closes a private channel.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: channels:write)
channelStringPrivateChannel to close.

<a name="closeDirectMessageChannel"/>

Slack.closeDirectMessageChannel

This method closes a direct message channel.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: channels:write)
channelStringDirect Message Channel to close.

<a name="getDirectMessageChannelHistory"/>

Slack.getDirectMessageChannelHistory

This method returns a portion of messages/events from the specified direct message channel. To read the entire history for a direct message channel, call the method with no latest or oldest arguments, and then continue paging using the instructions below.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: im:history)
channelStringChannel to fetch.
latestStringEnd of time range of messages to include in results.
oldestStringStart of time range of messages to include in results.
inclusiveNumberInclude messages with latest or oldest timestamp in results.
countNumberNumber of messages to return, between 1 and 1000.
unreadsStringInclude unread_count_display in the output?

<a name="getUserImChannels"/>

Slack.getUserImChannels

This method returns a list of all im channels that the user has.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: im:history)

<a name="markDirectMessageChannel"/>

Slack.markDirectMessageChannel

This method moves the read cursor in a direct message channel.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: im:write)
channelStringChannel to set reading cursor in.
tsStringTimestamp of the most recently seen message.

<a name="openDirectMessageChannel"/>

Slack.openDirectMessageChannel

This method opens a direct message channel with another member of your Slack team.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: im:write)
userStringUser to open a direct message channel with.
returnImStringBoolean, indicates you want the full IM channel definition in the response.

<a name="getAccessToken"/>

Slack.getAccessToken

This method allows you to exchange a temporary OAuth code for an API access token. This is used as part of the OAuth authentication flow.

FieldTypeDescription
clientIdStringIssued when you created your application.
clientSecretStringIssued when you created your application.
codeStringThe code param returned via the OAuth callback.
redirectUriStringThis must match the originally submitted URI (if one was sent).

<a name="closeMultipartyDirectMessageChannel"/>

Slack.closeMultipartyDirectMessageChannel

This method closes a multiparty direct message channel.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: mpim:write)
channelStringMultiparty Direct Message Channel to close.

<a name="getMultipartyDirectMessageChannelHistory"/>

Slack.getMultipartyDirectMessageChannelHistory

This method returns a portion of messages/events from the specified multiparty direct message channel. To read the entire history for a multiparty direct message, call the method with no latest or oldest arguments, and then continue paging using the instructions below.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: mpim:history)
channelStringChannel to fetch.
latestStringEnd of time range of messages to include in results.
oldestStringStart of time range of messages to include in results.
inclusiveNumberInclude messages with latest or oldest timestamp in results.
countNumberNumber of messages to return, between 1 and 1000.
unreadsStringInclude unread_count_display in the output?

<a name="getMultipartyDirectMessageChannels"/>

Slack.getMultipartyDirectMessageChannels

This method returns a list of all multiparty direct message channels that the user has.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: mpim:write)

<a name="markMultipartyDirectMessageChannel"/>

Slack.markMultipartyDirectMessageChannel

This method moves the read cursor in a multiparty direct message channel.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: mpim:write)
channelStringChannel to set reading cursor in.
tsStringTimestamp of the most recently seen message.

<a name="deleteChat"/>

Slack.deleteChat

This method deletes a message from a channel.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: chat:write:bot or chat:write:user)
channelStringChannel containing the message to be deleted.
timestampStringTimestamp of the message to be deleted.
asUserStringPass true to delete the message as the authed user. Bot users in this context are considered authed users.

<a name="openMultipartyDirectMessageChannel"/>

Slack.openMultipartyDirectMessageChannel

This method opens a multiparty direct message.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: channels:write)
channelStringMultiparty Direct Message to open.

<a name="sendMeMessage"/>

Slack.sendMeMessage

This method sends a me message to a channel from the calling user.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: chat:write:bot or chat:write:user)
channelStringChannel containing the message to be deleted.
textStringText of the message to send.

<a name="postMessage"/>

Slack.postMessage

This method posts a message to a public channel, private channel, or direct message/IM channel.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: chat:write:bot or chat:write:user)
channelStringChannel containing the message to be deleted.
textStringText of the message to send.
parseStringChange how messages are treated.
linkNamesStringFind and link channel names and usernames.
attachmentsJSONStructured message attachments.
unfurlLinksStringPass true to enable unfurling of primarily text-based content.
unfurlMediaStringPass false to disable unfurling of media content.
usernameStringSet your bot's user name. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below.
asUserStringPass true to post the message as the authed user, instead of as a bot. Defaults to false.
iconUrlStringURL to an image to use as the icon for this message. Must be used in conjunction with as_user set to false, otherwise ignored.
iconEmojiStringEmoji to use as the icon for this message. Overrides icon_url. Must be used in conjunction with as_user set to false, otherwise ignored.

<a name="updateMessage"/>

Slack.updateMessage

This method updates a message in a channel. Though related to chat.postMessage, some parameters of chat.update are handled differently.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: chat:write:bot or chat:write:user)
channelStringChannel containing the message to be deleted.
tsStringTimestamp of the message to be updated.
textStringText of the message to send.
parseStringChange how messages are treated.
linkNamesStringFind and link channel names and usernames.
attachmentsJSONStructured message attachments.
asUserStringPass true to post the message as the authed user, instead of as a bot. Defaults to false.

<a name="endDoNotDisturb"/>

Slack.endDoNotDisturb

Ends the user's currently scheduled Do Not Disturb session immediately.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: dnd:write)

<a name="endSnooze"/>

Slack.endSnooze

Ends the current user's snooze mode immediately.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: dnd:write)

<a name="getDoNotDisturbInfo"/>

Slack.getDoNotDisturbInfo

Provides information about a user's current Do Not Disturb settings.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: dnd:write)
userStringUser to fetch status for (defaults to current user)

<a name="setSnooze"/>

Slack.setSnooze

Adjusts the snooze duration for a user's Do Not Disturb settings. If a snooze session is not already active for the user, invoking this method will begin one for the specified duration.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: dnd:write)
numMinutesNumberNumber of minutes, from now, to snooze until.

<a name="getTeamUserDoNotDisturbInfo"/>

Slack.getTeamUserDoNotDisturbInfo

Provides information about the current Do Not Disturb settings for users of a Slack team.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: dnd:read)
usersNumberComma-separated list of users to fetch Do Not Disturb status for.

<a name="getTeamCustomEmoji"/>

Slack.getTeamCustomEmoji

This method lists the custom emoji for a team.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: emoji:read)

<a name="addFileComment"/>

Slack.addFileComment

Add a comment to an existing file.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: files:write:user)
fileStringFile to add a comment to.
commentStringText of the comment to add.
channelStringChannel id (encoded) of which location to associate with the new comment.

<a name="deleteFileComment"/>

Slack.deleteFileComment

Delete an existing comment on a file. Only the original author of the comment or a Team Administrator may delete a file comment.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: files:write:user)
fileStringFile to delete a comment from.
idStringThe comment to delete.

<a name="updateFileComment"/>

Slack.updateFileComment

Edit an existing comment on a file. Only the user who created a comment may make edits. Teams may configure a limited time window during which file comment edits are allowed.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: files:write:user)
fileStringFile to update a comment from.
idStringThe comment to update.
commentStringText of the comment to edit.

<a name="deleteFile"/>

Slack.deleteFile

This method deletes a file from your team.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: files:write:user)
fileStringID of file to delete.

<a name="uploadFile"/>

Slack.uploadFile

This method allows you to create or upload an existing file.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: files:write:user)
fileStringFile contents via multipart/form-data.
filetypeStringA file type identifier.
filenameStringFilename of file.
titleStringTitle of file.
initialCommentStringInitial comment to add to file.
channelsStringComma-separated list of channel names or IDs where the file will be shared.

<a name="getFileInfo"/>

Slack.getFileInfo

This method returns information about a file in your team.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: files:read)
fileStringSpecify a file by providing its ID.
countStringNumber of items to return per page.
pageStringPage number of results to return.

<a name="getTeamFiles"/>

Slack.getTeamFiles

This method returns a list of files within the team. It can be filtered and sliced in various ways.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: files:read)
userStringFilter files created by a single user.
channelStringFilter files appearing in a specific channel, indicated by its ID.
timestampFromStringFilter files created after this timestamp (inclusive).
timestampToStringFilter files created before this timestamp (inclusive).
typesStringFilter files by type: all - All files; spaces - Posts; snippets - Snippets; images - Image files; gdocs - Google docs; zips - Zip files; pdfs - PDF files. You can pass multiple values in the types argument like types=spaces,snippets.The default value is all, which does not filter the list.
countStringNumber of items to return per page.
pageStringPage number of results to return.

<a name="disableFileSharing"/>

Slack.disableFileSharing

Method description

FieldTypeDescription
tokenStringAuthentication token (Requires scope: files:write:user)
fileStringFile to revoke.

<a name="disableFileSharing"/>

Slack.disableFileSharing

This method disables public/external sharing for a file.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: files:write:user)
fileStringFile to revoke.

<a name="enableFileSharing"/>

Slack.enableFileSharing

This method enables public/external sharing for a file.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: files:write:user)
fileStringFile to revoke.

<a name="pinItemToChannel"/>

Slack.pinItemToChannel

This method pins an item (file, file comment, channel message, or group message) to a particular channel. The channel argument is required and one of file, file_comment, or timestamp must also be specified.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: pins:write)
channelStringChannel to pin the item in.
fileStringFile to pin.
fileCommentStringFile comment to pin.
timestampStringTimestamp of the message to pin.

<a name="getChannelPinnedItems"/>

Slack.getChannelPinnedItems

This method lists the items pinned to a channel.

FieldTypeDescription
tokenStringRequires scope: pins:read
channelStringChannel fetch pins.

<a name="unpinItemToChannel"/>

Slack.unpinItemToChannel

This method un-pins an item (file, file comment, channel message, or group message) from a channel. The channel argument is required and one of file, file_comment, or timestamp must also be specified.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: pins:write)
channelStringChannel to pin the item in.
fileStringFile to un-pin.
fileCommentStringFile comment to un-pin.
timestampStringTimestamp of the message to un-pin.

<a name="addReaction"/>

Slack.addReaction

This method adds a reaction (emoji) to an item (file, file comment, channel message, group message, or direct message). One of file, file_comment, or the combination of channel and timestamp must be specified.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: pins:write)
nameStringReaction (emoji) name.
fileStringFile to add reaction to.
fileCommentStringFile comment to add reaction to.
channelStringChannel where the message to add reaction to was posted.
timestampStringTimestamp of the message to add reaction to.

<a name="getReaction"/>

Slack.getReaction

This method returns a list of all reactions for a single item (file, file comment, channel message, group message, or direct message).

FieldTypeDescription
tokenStringAuthentication token (Requires scope: pins:write)
fileStringFile to get reaction to.
fileCommentStringFile comment to get reaction to.
channelStringChannel where the message to get reaction to was posted.
timestampStringTimestamp of the message to get reaction to.
fullStringIf true always return the complete reaction list.

<a name="getReactions"/>

Slack.getReactions

This method returns a list of all items (file, file comment, channel message, group message, or direct message) reacted to by a user.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: pins:write)
userStringShow reactions made by this user. Defaults to the authed user.
fullStringIf true always return the complete reaction list.
countStringNumber of items to return per page.
pageStringPage number of results to return.

<a name="removeReaction"/>

Slack.removeReaction

This method removes a reaction (emoji) from an item (file, file comment, channel message, group message, or direct message). One of file, file_comment, or the combination of channel and timestamp must be specified.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: pins:write)
nameStringReaction (emoji) name.
fileStringFile to remove reaction from.
fileCommentStringFile comment to remove reaction from.
channelStringChannel where the message to remove reaction from was posted.
timestampStringTimestamp of the message to remove reaction from.

<a name="startRealTimeMessaging"/>

Slack.startRealTimeMessaging

This method starts a Real Time Messaging API session. Refer to the RTM API documentation for full details on how to use the RTM API.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: pins:write)
simpleLatestStringReturn timestamp only for latest message object of each channel (improves performance).
noUnreadsStringSkip unread counts for each channel (improves performance).
mpimAwareStringReturns MPIMs to the client in the API response.

<a name="searchItem"/>

Slack.searchItem

This method allows users and applications to search both messages and files in a single call.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: pins:write)
queryStringSearch query. May contains booleans, etc.
sortStringReturn matches sorted by either score or timestamp.
sortDirStringChange sort direction to ascending (asc) or descending (desc).
highlightNumberPass a value of 1 to enable query highlight markers (see below).
countStringNumber of items to return per page.
pageStringPage number of results to return.

<a name="addStar"/>

Slack.addStar

This method adds a star to an item (message, file, file comment, channel, private group, or DM) on behalf of the authenticated user. One of file, file_comment, channel, or the combination of channel and timestamp must be specified.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: starts:write)
fileStringFile to add star to.
fileCommentStringFile comment to add star to.
channelStringChannel to add star to, or channel where the message to add star to was posted (used with timestamp).
timestampStringTimestamp of the message to add star to.

<a name="getStarts"/>

Slack.getStarts

This method lists the items starred by the authed user.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: starts:read)
countStringNumber of items to return per page.
pageStringPage number of results to return.

<a name="removeStar"/>

Slack.removeStar

This method removes a star from an item (message, file, file comment, channel, private group, or DM) on behalf of the authenticated user. One of file, file_comment, channel, or the combination of channel and timestamp must be specified.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: starts:write)
fileStringFile to remove star from.
fileCommentStringFile comment to remove star from.
channelStringChannel to remove star to, or channel where the message to remove star to was posted (used with timestamp).
timestampStringTimestamp of the message to remove star from.

<a name="getTeamInfo"/>

Slack.getTeamInfo

This method provides information about your team.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: team:read)

<a name="getTeamProfile"/>

Slack.getTeamProfile

This method is used to get the profile field definitions for this team.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: users.profile:read)
visibilityStringFilter by visibility. (all)

<a name="getAccessLogs"/>

Slack.getAccessLogs

This method is used to get the access logs for users on a team.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: admin).
countStringNumber of items to return per page.
pageStringPage number of results to return.

<a name="createUserGroup"/>

Slack.createUserGroup

This method is used to create a User Group.

FieldTypeDescription
tokenStringAuthentication token (Requires scope usergroups:write).
nameStringA name for the User Group. Must be unique among User Groups.
handleStringA mention handle. Must be unique among channels, users and User Groups.
descriptionStringA short description of the User Group.
channelsStringA comma separated string of encoded channel IDs for which the User Group uses as a default.
includeCountStringInclude the number of users in each User Group.

<a name="disableUserGroup"/>

Slack.disableUserGroup

This method disables an existing User Group.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: usergroups:write).
usergroupStringThe encoded ID of the User Group to disable.
includeСountStringInclude the number of users in the User Group.

<a name="enableUserGroup"/>

Slack.enableUserGroup

This method enables a User Group which was previously disabled.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: usergroups:write).
usergroupStringThe encoded ID of the User Group to enable.
includeСountStringInclude the number of users in the User Group.

<a name="getUserGroups"/>

Slack.getUserGroups

This method returns a list of all User Groups in the team. This can optionally include disabled User Groups.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: usergroups:read).
includeDisabledStringInclude disabled User Groups.
includeСountStringInclude the number of users in each User Group.
includeUsersStringInclude the list of users for each User Group.

<a name="updateUserGroup"/>

Slack.updateUserGroup

This method updates the properties of an existing User Group.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: usergroups:write).
usergroupStringThe encoded ID of the User Group to update.
nameStringA name for the User Group. Must be unique among User Groups.
handleStringA mention handle. Must be unique among channels, users and User Groups.
descriptionStringA short description of the User Group.
channelsStringA comma separated string of encoded channel IDs for which the User Group uses as a default.
includeCountStringInclude the number of users in the User Group.

<a name="getUserGroupUsers"/>

Slack.getUserGroupUsers

This method returns a list of all users within a User Group.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: usergroups:write).
usergroupStringThe encoded ID of the User Group to update.
includeDisabledStringInclude the number of users in the User Group.

<a name="updateUserGroupUsers"/>

Slack.updateUserGroupUsers

This method updates the list of users that belong to a User Group. This method replaces all users in a User Group with the list of users provided in the users parameter.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: usergroups:write)
usergroupStringThe encoded ID of the User Group to update.
usersStringA comma separated string of encoded user IDs that represent the entire list of users for the User Group.
includeCountNumberInclude the number of users in the User Group.

<a name="getUserProfile"/>

Slack.getUserProfile

This method is used to get the profile information for a user.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: users.profile:read)
userStringUser to retrieve profile info for.
includeLabelsNumberInclude labels for each ID in custom profile fields. (0)

<a name="setUserProfile"/>

Slack.setUserProfile

This method is used to set the profile information for a user.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: users.profile:write)
userStringID of user to change. This argument may only be specified by team admins on paid teams.
profileJSONCollection of key:value pairs presented as a URL-encoded JSON hash.
nameStringName of a single key to set. Usable only if profile is not passed.
valueStringValue to set a single key to. Usable only if profile is not passed.

<a name="deleteUserProfilePhoto"/>

Slack.deleteUserProfilePhoto

This method allows the user to delete their profile image. It will clear whatever image is currently set.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: users.profile:write)

<a name="getUserPresence"/>

Slack.getUserPresence

This method lets you find out information about a user's presence. Consult the presence documentation for more details.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: users:read)
userStringUser to get presence info on. Defaults to the authed user.

<a name="getUserIdentity"/>

Slack.getUserIdentity

After your Slack app is awarded an identity token through Sign in with Slack, use this method to retrieve a user's identity.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: identity.basic)

<a name="getUser"/>

Slack.getUser

This method returns information about a team member.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: users:read)
userStringUser to get presence info on. Defaults to the authed user.

<a name="getTeamUsers"/>

Slack.getTeamUsers

This method returns a list of all users in the team. This includes deleted/deactivated users.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: users:read)
presenceStringWhether to include presence data in the output.

<a name="setUserActive"/>

Slack.setUserActive

This method lets the slack messaging server know that the authenticated user is currently active.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: users:write)

<a name="setPhoto"/>

Slack.setPhoto

This method allows the user to set their profile image. The caller can pass image data via image.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: users:write)
imageStringFile contents.
cropXNumberX coordinate of top-left corner of crop box.
cropYNumberY coordinate of top-left corner of crop box.
cropWNumberWidth/height of crop box (always square).

<a name="setUserPresence"/>

Slack.setUserPresence

This method lets you set the calling user's manual presence. Consult the presence documentation for more details.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: users:write)
presenceStringEither auto or away.

<a name="markReminderComplete"/>

Slack.markReminderComplete

This method completes a reminder.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: users:write)
reminderStringThe ID of the reminder to be marked as complete.

<a name="createReminder"/>

Slack.createReminder

This method creates a reminder.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: reminders:write)
textStringThe content of the reminder.
timeStringWhen 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")
userStringThe user who will receive the reminder. If no user is specified, the reminder will go to user who created it.

<a name="deleteReminder"/>

Slack.deleteReminder

This method deletes a reminder.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: users:write)
reminderStringThe ID of the reminder to delete.

<a name="getSingleReminder"/>

Slack.getSingleReminder

This method returns information about a reminder.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: users:write)
reminderStringThe ID of the reminder.

<a name="getReminders"/>

Slack.getReminders

This method lists all reminders created by or for a given user.

FieldTypeDescription
tokenStringAuthentication token (Requires scope: users:read)
x
circle
Slack
$ / m
We will charge your card every month for the plan amount, as well as any overages incurred in the previous month.
?

Oops, we are missing some details

Looks like there are a few missing details that you haven't filled in yet.
These details are important and will help us protect you and let you know about anything new.

x

Connect your app to APIs via RapidAPI

Consume and monitor multiple APIs through the RapidAPI SDK.
Click start to set up your app and connect to your first API.

START

Give your app a name

This app will be used in RapidAPI to collect and connect all the APIs you need.

NEXT

Connect your project

Choose your backend language and then install & require the RapidAPI SDK.

  • node
    NodeJS
  • php
    PHP
  • python
    Python
  • objc
    Obj-C
  • android
    Android
  • go
    GO
  • ruby
    Ruby
  • csharp
    C#

Install SDK

Run the following command to install the SDK:

npm install rapidapi-connect --save

Require SDK

In your code, add the following code to require the RapidAPI SDK:

NEXT

Hooray! You are connected

Use the following code to try it out by getting all the APIs that are on RapidAPI.

rapid.call('RapidAPI', 'getAll', {'{}'});
FINISH
esccloses this view
x

Login to RapidAPI

Create endpoints based on popular APIs and share with others.
Follow popular APIs and get updated. Stand out in the community of developers.

Login with Github
Login with Facebook
Login with Google
Or
Remember Me

  • We're not going to post anything on your wall.
  • We're not planning to spam you.
  • esccloses this view
    x

    Why sign up to RapidAPI?

    • integrate
      Integrate APIs into your app
      Ruby, Java, Elixir, Node.js, Phyton, Objective C, Swift, PHP and MORE
    • keys
      Save all API keys in one place
    • notifications
      Get notifications about API changes
    • stats
      Get stats and monitor API connections
    Sign up with Github
    Sign up with Facebook
    Sign up with Google
  • We're not going to post anything on your wall.
  • We're not planning to spam you.
  • esccloses this view
    x

    Authentication

    Authenticate
    esccloses this view