Articles in this section

Available Slack APIs

Tanisha Ray
Updated

When you configure an export, import, or other type of flow step using the prebuilt Slack connector, you can select any of the API operations listed below, organized by API type.

Note

If your API endpoint isn’t listed here, switch the flow step to HTTP mode and configure the endpoint provided in the Slack API documentation. You can also create a composite endpoint for this application in HTTP mode.

Resource API endpoint Export Import
Admin Retrieve analytics data X
Get logs for a specified team/organization X
Approve an app for installation on a workspace X
List approved apps for an organization or workspace X
Clear an app resolution X
Look up the app config for connectors by their IDs X
Set the app config for a connector X
Cancel app request for team X
List app requests for a team/workspace X
Restrict an app for installation on a workspace X
List restricted apps for an organization or workspace X
Uninstall an app from one or many workspaces, or an entire enterprise organization X
Read the allow list of IP blocks and ASNs from the enterprise configuration X
Write/overwrite the allow list of IP blocks and ASNs from the enterprise configuration X
Assign entities to a particular authentication policy X
Fetch all the entities assigned to a particular authentication policy by name X
Remove specified entities from a specified authentication policy X
Create an information barrier X
Delete an existing information barrier X
Get all information barriers for your organization X
Update an existing information barrier X
Archive a public or private channel X
Archive public or private channels in bulk X
Delete public or private channels in bulk X
Move public or private channels in bulk X
Convert a public channel to a private channel X
Convert a private channel to a public channel X
Create a public or private channel based conversation X
Create a Salesforce channel for the corresponding object provided X
Disconnect a connected channel from one or more workspaces X
List all disconnected channels X
Get conversation preferences for a public or private channel X
Get a conversation's retention policy X
Get all the workspaces for a given public or private channel  X
Invite a user to a public or private channel X
Link a Salesforce record to a channel X
Return channels on the given team using the filters X
Remove a conversation's retention policy X
Rename a public or private channel X
Add an allowlist of IDP groups for accessing a channel X
List all IDP groups linked to a channel X
Remove a linked IDP group linked from a private channel X
Search for public or private channels in an enterprise organization X
Set the posting permissions for a public or private channel X
Set a conversation's retention policy X
Set the workspaces in an enterprise organization  X
Unarchive a public or private channel X
Unlink a Salesforce record from a channel X
Add an emoji X
Add an emoji alias X
List emoji for an enterprise organization X
Remove an emoji across an enterprise organization X
Rename an emoji X
Look up functions by a set of apps X
Look up the visibility of multiple Slack functions  X
Set the visibility of a Slack function  X
Approve a workspace invite request X
List all approved workspace invite requests X
List all denied workspace invite requests X
Deny a workspace invite request X
List all pending workspace invite requests X
Add members to the specified role with the specified scopes X
Lists assignments for all roles across entities X
Remove a set of users from a role for the given scopes and entities X
List all of the admins on a given workspace X
Create an enterprise team X
List all teams in an enterprise organization X
List all of the owners on a given workspace X
Fetch information about settings in a workspace X
Set the default channels of a workspace X
Set the description of a given workspace X
Set the discoverability of a given workspace X
Set the icon of a workspace X
Set the name of a given workspace X
Add up to one hundred default channels to an IDP group X
Associate one or more default workspaces with an organization wide IDP group X
List the channels linked to an organization level IDP group (user group) X
Remove one or more default channels from an organization level IDP group (user group) X
Add an enterprise user to a workspace X
Fetches the expiration timestamp for a guest X
Invite a user to a workspace X
List users on a workspace X
Remove a user from a workspace X
Clear user specific session settings for a list of users X
Get user specific session settings given a list of users X
Revoke a single session for a user X
List active user sessions for an organization X
Wipe all valid sessions on all devices for a given user X
Enqueues an asynchronous job to wipe all valid sessions on all devices for a given list of users X
Configure the user level session settings for one or more users X
Set an existing regular user or owner to be a workspace admin X
Set an expiration for a guest user X
Set an existing regular user or admin to be a workspace owner X
Set an existing guest user, admin user, or owner to be a regular user X
Ask Slackbot to send an export listing all workspace members using unsupported software, presented as a zipped CSV file X
Add collaborators to workflows within the team or enterprise X
Remove collaborators from workflows within the team or enterprise X
Look up the permissions for a set of workflows X
Search workflows within the team or enterprise X
List the permissions for using each trigger type X
Set the permissions for using a trigger type X
Unpublish workflows within the team or enterprise X
API Checks API calling code X
Apps Get logs for a specified app X
Get the access token for the provided token ID X
Count the number of items in a datastore that match a query X
Assistant Search messages across your Slack organization (Beta) X
Return search capabilities on a given team (Beta) X
Set the status for an AI assistant thread X
Set suggested prompts for the given assistant thread X
Set the title for the given assistant thread X
Bookmarks Add bookmark to a channel X
Edit bookmark X
List bookmark for the channel X
Remove bookmark from the channel X
Canvases Remove access to a canvas for specified entities X
Set the access level to a canvas for specified entities X
Create canvas for a user X
Delete a canvas X
Update an existing canvas X
Find sections matching the provided criteria X
Chat Append text to an existing streaming conversation X
Start a new streaming conversation X
Stop a streaming conversation X
Conversations Create a channel canvas for a channel X
Upgrade or downgrade Slack connect channel permissions between 'can post only' and 'can post and invite' X
Approve a request to add an external user to a channel and sends them a Slack connect invite X
Denies a request to invite an external user to a channel X
Lists requests to add external users to channels with ability to filter X
Entity Provide custom flexpane behavior for work objects X
Files Delete an existing comment on a file X
Finish an upload started with files get upload URL external X
Functions Signal that a function failed to complete X
Signal the successful completion of a function X
Grant users access to a custom Slack function X
List the access type of a custom Slack function and include the users, team or organization IDs  X
Revoke user access to a custom Slack function X
Set the access type of a custom Slack function and define the users, team or organization IDs  X
List the steps of a specific function of a workflow's versions X
Download form responses of a workflow X
Groups (v1.1) Return a list of groups X
Retrieve a single group resource X
Create a new group X
Update an existing group resource (allowing individual users to be added or removed from the group) X
Update an existing group resource (overwriting all values for a group) X
Permanently remove a group X
Groups (v2.0) Return a list of groups X
Retrieve a single group resource X
Create a new group X
Update an existing group resource, overwriting all values X
Update an existing group resource X
Permanently remove a group X
Lists Revoke access to a list for specified entities X
Set the access level to a list for specified entities X
Create a list X
Retrieve list download URL from an export job to download list contents X
Initiate a job to export list contents X
Add a new item to an existing list X
Delete an item from an existing list X
Delete multiple items from an existing list X
Get a row from a list X
Get records from a list X
Update cells in a list X
Update a list X
Migration For enterprise organization workspaces, map local user IDs to global user IDs X
Resource types Return Slack's type of resources available X
RTM Start a real time messaging session X
Schemas (v1.1) Return Slack's configuration details for how users are formatted X
Return Slack's configuration details for how groups are formatted X
Schemas (v2.0) Return Slack's configuration details for how users are formatted X
Return Slack's configuration details for how groups are formatted X
Return a list of Slack supported schemas along with Slack's configuration details X
Search Search for files matching a query X
Service provider configuration Return Slack's configuration details X
Team Gets the access logs for the current team X
Disconnect an external organization X
Return a list of all the external teams connected and details about the connection X
Retrieve a team's profile X
Users Look up an email address to see if someone is discoverable on Slack X
Retrieve a user's profile information, including their custom status X
Set a user's profile information, including custom status X
Set the user profile photo X
Users (v1.1) Return a list of users X
Retrieve a single user resource X
Create a user X
Create a multi channel guest user X
Update an existing user resource (overwriting values for specified attributes) X
Update an existing user resource (overwriting all values for a user) X
Set a Slack user to deactivated X
Users (v2.0) Return a list of users X
Retrieve a single user resource X
Create a user X
Create a multi channel guest users X
Update an existing user resource (overwriting all values) X
Update an existing user resource (overwriting specified values) X
Set a Slack user to deactivated X
User groups Update users user groups X
Workflows Add featured workflows to a channel X
List the featured workflows for specified channels X
Remove featured workflows from a channel X
Set featured workflows for a channel X
Allows users to run a trigger X
Return the permission type of a trigger  X
Revoke an entity's access to a trigger  X
Set the permission type for who can run a trigger X

Available DI objects

The following objects are available when using Slack as a source in Celigo Data Integration (DI).

Primary key: All Slack DI objects use a top-level string id as the primary key (Conversations/channels, Users/members, User groups, Files, Reminders). Slack returns a unique id on every object, so id is the consistent key across resources.

Note

Slack's Web API list methods return only currently-active objects. Slack does not provide a deleted-records feed; instead, deactivated users carry a deleted flag and archived channels carry an is_archived flag (soft states), while deleted files, reminders, and user groups simply stop appearing in list results rather than being returned with a deleted marker.

Object API endpoint Available extract modes Delta field
Conversations Conversations list Full —
Files Files list Full, Incremental ts_from
Reminders Reminders list Full —
User groups List user groups Full —
Users Users list Full —

Response schemas

Click an object below to view its response fields and delta configuration.

Conversations — Conversations list

Response schema:

Field Type
id string (Primary key)
name string
name_normalized string
is_channel boolean
is_group boolean
is_im boolean
is_mpim boolean
is_private boolean
created number
creator string
is_archived boolean
is_general boolean
unlinked number
is_shared boolean
is_org_shared boolean
is_pending_ext_shared boolean
is_ext_shared boolean
is_member boolean
num_members number
updated number
context_team_id string
topic object
topic.value string
topic.creator string
topic.last_set number
purpose object
purpose.value string
purpose.creator string
purpose.last_set number
previous_names stringarray
shared_team_ids stringarray
Files — Files list

Delta configuration: use it to request incremental data.

Setting Value
Delta filter ts_from = {{lastExportDateTime}}
Date format X

Response schema:

Field Type
id string (Primary key)
created number
timestamp number
name string
title string
mimetype string
filetype string
pretty_type string
user string
editable boolean
size number
mode string
is_external boolean
external_type string
is_public boolean
public_url_shared boolean
display_as_bot boolean
username string
url_private string
url_private_download string
permalink string
permalink_public string
comments_count number
channels stringarray
groups stringarray
ims stringarray
Reminders — Reminders list

Response schema:

Field Type
id string (Primary key)
creator string
user string
text string
recurring boolean
time number
complete_ts number
User groups — List user groups

Response schema:

Field Type
id string (Primary key)
team_id string
is_usergroup boolean
name string
description string
handle string
is_external boolean
date_create number
date_update number
date_delete number
auto_type string
created_by string
updated_by string
deleted_by string
user_count number
prefs object
prefs.channels stringarray
prefs.groups stringarray
users stringarray
Users — Users list

Response schema:

Field Type
id string (Primary key)
team_id string
name string
deleted boolean
color string
real_name string
tz string
tz_label string
tz_offset number
is_admin boolean
is_owner boolean
is_primary_owner boolean
is_restricted boolean
is_ultra_restricted boolean
is_bot boolean
is_app_user boolean
updated number
is_email_confirmed boolean
who_can_share_contact_card string
profile object
profile.title string
profile.phone string
profile.skype string
profile.real_name string
profile.real_name_normalized string
profile.display_name string
profile.display_name_normalized string
profile.status_text string
profile.status_emoji string
profile.status_expiration number
profile.avatar_hash string
profile.first_name string
profile.last_name string
profile.email string
profile.team string
profile.image_24 string
profile.image_32 string
profile.image_48 string
profile.image_72 string
profile.image_192 string
profile.image_512 string