This connector is optimized for AI agents. For the data replication connector, see Slack .
This is the full reference documentation for the Slack agent connector.
Supported entities and actions
The Slack connector supports the following entities and actions.
Users
Users List
Returns a list of all users in the Slack workspace
Python SDK
API
curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {your_auth_token}' \ --data '{ "entity": "users", "action": "list" }'
Parameters
Parameter Name Type Required Description cursorstringNo Pagination cursor for next page limitintegerNo Number of users to return per page
Response Schema Records Field Name Type Description idstringteam_idstring | nullnamestring | nulldeletedboolean | nullcolorstring | nullreal_namestring | nulltzstring | nulltz_labelstring | nulltz_offsetinteger | nullprofileobject | anyis_adminboolean | nullis_ownerboolean | nullis_primary_ownerboolean | nullis_restrictedboolean | nullis_ultra_restrictedboolean | nullis_botboolean | nullis_app_userboolean | nullupdatedinteger | nullis_email_confirmedboolean | nullwho_can_share_contact_cardstring | null
Field Name Type Description next_cursorstring | null
Users Get
Get information about a single user by ID
Python SDK
await slack . users . get ( user = "<str>" )
API
curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {your_auth_token}' \ --data '{ "entity": "users", "action": "get", "params": { "user": "<str>" } }'
Parameters
Parameter Name Type Required Description userstringYes User ID
Response Schema Records Field Name Type Description idstringteam_idstring | nullnamestring | nulldeletedboolean | nullcolorstring | nullreal_namestring | nulltzstring | nulltz_labelstring | nulltz_offsetinteger | nullprofileobject | anyis_adminboolean | nullis_ownerboolean | nullis_primary_ownerboolean | nullis_restrictedboolean | nullis_ultra_restrictedboolean | nullis_botboolean | nullis_app_userboolean | nullupdatedinteger | nullis_email_confirmedboolean | nullwho_can_share_contact_cardstring | null
Users Search
Search and filter users records powered by Airbyte's data sync. This often provides additional fields and operators beyond what the API natively supports, making it easier to narrow down results before performing further operations. Only available in hosted mode.
Python SDK
await slack . users . search ( query = { "filter" : { "eq" : { "color" : "<str>" } } } )
API
curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {your_auth_token}' \ --data '{ "entity": "users", "action": "search", "params": { "query": {"filter": {"eq": {"color": "<str>"}}} } }'
Parameters
Parameter Name Type Required Description queryobjectYes Filter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, like, fuzzy, keyword, not, and, or query.filterobjectNo Filter conditions query.sortarrayNo Sort conditions limitintegerNo Maximum results to return (default 1000) cursorstringNo Pagination cursor from previous response's meta.cursor fieldsarrayNo Field paths to include in results
Searchable Fields
Field Name Type Description colorstringThe color assigned to the user for visual purposes. deletedbooleanIndicates if the user is deleted or not. has_2fabooleanFlag indicating if the user has two-factor authentication enabled. idstringUnique identifier for the user. is_adminbooleanFlag specifying if the user is an admin or not. is_app_userbooleanSpecifies if the user is an app user. is_botbooleanIndicates if the user is a bot account. is_email_confirmedbooleanFlag indicating if the user's email is confirmed. is_forgottenbooleanSpecifies if the user is marked as forgotten. is_invited_userbooleanIndicates if the user is invited or not. is_ownerbooleanFlag indicating if the user is an owner. is_primary_ownerbooleanSpecifies if the user is the primary owner. is_restrictedbooleanFlag specifying if the user is restricted. is_ultra_restrictedbooleanIndicates if the user has ultra-restricted access. namestringThe username of the user. profileobjectUser's profile information containing detailed details. real_namestringThe real name of the user. team_idstringUnique identifier for the team the user belongs to. tzstringTimezone of the user. tz_labelstringLabel representing the timezone of the user. tz_offsetintegerOffset of the user's timezone. updatedintegerTimestamp of when the user's information was last updated. who_can_share_contact_cardstringSpecifies who can share the user's contact card.
Response Schema Field Name Type Description dataarrayList of matching records metaobjectPagination metadata meta.has_morebooleanWhether additional pages are available meta.cursorstring | nullCursor for next page of results meta.took_msnumber | nullQuery execution time in milliseconds data[].colorstringThe color assigned to the user for visual purposes. data[].deletedbooleanIndicates if the user is deleted or not. data[].has_2fabooleanFlag indicating if the user has two-factor authentication enabled. data[].idstringUnique identifier for the user. data[].is_adminbooleanFlag specifying if the user is an admin or not. data[].is_app_userbooleanSpecifies if the user is an app user. data[].is_botbooleanIndicates if the user is a bot account. data[].is_email_confirmedbooleanFlag indicating if the user's email is confirmed. data[].is_forgottenbooleanSpecifies if the user is marked as forgotten. data[].is_invited_userbooleanIndicates if the user is invited or not. data[].is_ownerbooleanFlag indicating if the user is an owner. data[].is_primary_ownerbooleanSpecifies if the user is the primary owner. data[].is_restrictedbooleanFlag specifying if the user is restricted. data[].is_ultra_restrictedbooleanIndicates if the user has ultra-restricted access. data[].namestringThe username of the user. data[].profileobjectUser's profile information containing detailed details. data[].real_namestringThe real name of the user. data[].team_idstringUnique identifier for the team the user belongs to. data[].tzstringTimezone of the user. data[].tz_labelstringLabel representing the timezone of the user. data[].tz_offsetintegerOffset of the user's timezone. data[].updatedintegerTimestamp of when the user's information was last updated. data[].who_can_share_contact_cardstringSpecifies who can share the user's contact card.
Channels
Channels List
Returns a list of all channels in the Slack workspace
Python SDK
await slack . channels . list ( )
API
curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {your_auth_token}' \ --data '{ "entity": "channels", "action": "list" }'
Parameters
Parameter Name Type Required Description cursorstringNo Pagination cursor for next page limitintegerNo Number of channels to return per page typesstringNo Mix and match channel types (public_channel, private_channel, mpim, im) exclude_archivedbooleanNo Exclude archived channels
Response Schema Records Field Name Type Description idstringnamestring | nullis_channelboolean | nullis_groupboolean | nullis_imboolean | nullis_mpimboolean | nullis_privateboolean | nullcreatedinteger | nullis_archivedboolean | nullis_generalboolean | nullunlinkedinteger | nullname_normalizedstring | nullis_sharedboolean | nullis_org_sharedboolean | nullis_pending_ext_sharedboolean | nullpending_sharedarray | nullcontext_team_idstring | nullupdatedinteger | nullcreatorstring | nullis_ext_sharedboolean | nullshared_team_idsarray | nullpending_connected_team_idsarray | nullis_memberboolean | nulltopicobject | anypurposeobject | anyprevious_namesarray | nullnum_membersinteger | nullparent_conversationstring | nullpropertiesobject | nullis_thread_onlyboolean | nullis_read_onlyboolean | null
Field Name Type Description next_cursorstring | null
Channels Get
Get information about a single channel by ID
Python SDK
await slack . channels . get ( channel = "<str>" )
API
curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {your_auth_token}' \ --data '{ "entity": "channels", "action": "get", "params": { "channel": "<str>" } }'
Parameters
Parameter Name Type Required Description channelstringYes Channel ID
Response Schema Records Field Name Type Description idstringnamestring | nullis_channelboolean | nullis_groupboolean | nullis_imboolean | nullis_mpimboolean | nullis_privateboolean | nullcreatedinteger | nullis_archivedboolean | nullis_generalboolean | nullunlinkedinteger | nullname_normalizedstring | nullis_sharedboolean | nullis_org_sharedboolean | nullis_pending_ext_sharedboolean | nullpending_sharedarray | nullcontext_team_idstring | nullupdatedinteger | nullcreatorstring | nullis_ext_sharedboolean | nullshared_team_idsarray | nullpending_connected_team_idsarray | nullis_memberboolean | nulltopicobject | anypurposeobject | anyprevious_namesarray | nullnum_membersinteger | nullparent_conversationstring | nullpropertiesobject | nullis_thread_onlyboolean | nullis_read_onlyboolean | null
Channels Create
Creates a new public or private channel
Python SDK
await slack . channels . create ( name = "<str>" , is_private = True )
API
curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {your_auth_token}' \ --data '{ "entity": "channels", "action": "create", "params": { "name": "<str>", "is_private": True } }'
Parameters
Parameter Name Type Required Description namestringYes Channel name (lowercase, no spaces, max 80 chars) is_privatebooleanNo Create a private channel instead of public
Response Schema Records Field Name Type Description idstringnamestring | nullis_channelboolean | nullis_groupboolean | nullis_imboolean | nullis_mpimboolean | nullis_privateboolean | nullcreatedinteger | nullis_archivedboolean | nullis_generalboolean | nullunlinkedinteger | nullname_normalizedstring | nullis_sharedboolean | nullis_org_sharedboolean | nullis_pending_ext_sharedboolean | nullpending_sharedarray | nullcontext_team_idstring | nullupdatedinteger | nullcreatorstring | nullis_ext_sharedboolean | nullshared_team_idsarray | nullpending_connected_team_idsarray | nullis_memberboolean | nulltopicobject | anypurposeobject | anyprevious_namesarray | nullnum_membersinteger | nullparent_conversationstring | nullpropertiesobject | nullis_thread_onlyboolean | nullis_read_onlyboolean | null
Channels Update
Renames an existing channel
Python SDK
await slack . channels . update ( channel = "<str>" , name = "<str>" )
API
curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {your_auth_token}' \ --data '{ "entity": "channels", "action": "update", "params": { "channel": "<str>", "name": "<str>" } }'
Parameters
Parameter Name Type Required Description channelstringYes Channel ID to rename namestringYes New channel name (lowercase, no spaces, max 80 chars)
Response Schema Records Field Name Type Description idstringnamestring | nullis_channelboolean | nullis_groupboolean | nullis_imboolean | nullis_mpimboolean | nullis_privateboolean | nullcreatedinteger | nullis_archivedboolean | nullis_generalboolean | nullunlinkedinteger | nullname_normalizedstring | nullis_sharedboolean | nullis_org_sharedboolean | nullis_pending_ext_sharedboolean | nullpending_sharedarray | nullcontext_team_idstring | nullupdatedinteger | nullcreatorstring | nullis_ext_sharedboolean | nullshared_team_idsarray | nullpending_connected_team_idsarray | nullis_memberboolean | nulltopicobject | anypurposeobject | anyprevious_namesarray | nullnum_membersinteger | nullparent_conversationstring | nullpropertiesobject | nullis_thread_onlyboolean | nullis_read_onlyboolean | null
Channels Search
Search and filter channels records powered by Airbyte's data sync. This often provides additional fields and operators beyond what the API natively supports, making it easier to narrow down results before performing further operations. Only available in hosted mode.
Python SDK
await slack . channels . search ( query = { "filter" : { "eq" : { "context_team_id" : "<str>" } } } )
API
curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {your_auth_token}' \ --data '{ "entity": "channels", "action": "search", "params": { "query": {"filter": {"eq": {"context_team_id": "<str>"}}} } }'
Parameters
Parameter Name Type Required Description queryobjectYes Filter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, like, fuzzy, keyword, not, and, or query.filterobjectNo Filter conditions query.sortarrayNo Sort conditions limitintegerNo Maximum results to return (default 1000) cursorstringNo Pagination cursor from previous response's meta.cursor fieldsarrayNo Field paths to include in results
Searchable Fields
Field Name Type Description context_team_idstringThe unique identifier of the team context in which the channel exists. createdintegerThe timestamp when the channel was created. creatorstringThe ID of the user who created the channel. idstringThe unique identifier of the channel. is_archivedbooleanIndicates if the channel is archived. is_channelbooleanIndicates if the entity is a channel. is_ext_sharedbooleanIndicates if the channel is externally shared. is_generalbooleanIndicates if the channel is a general channel in the workspace. is_groupbooleanIndicates if the channel is a group (private channel) rather than a regular channel. is_imbooleanIndicates if the entity is a direct message (IM) channel. is_memberbooleanIndicates if the calling user is a member of the channel. is_mpimbooleanIndicates if the entity is a multiple person direct message (MPIM) channel. is_org_sharedbooleanIndicates if the channel is organization-wide shared. is_pending_ext_sharedbooleanIndicates if the channel is pending external shared. is_privatebooleanIndicates if the channel is a private channel. is_read_onlybooleanIndicates if the channel is read-only. is_sharedbooleanIndicates if the channel is shared. last_readstringThe timestamp of the user's last read message in the channel. localestringThe locale of the channel. namestringThe name of the channel. name_normalizedstringThe normalized name of the channel. num_membersintegerThe number of members in the channel. parent_conversationstringThe parent conversation of the channel. pending_connected_team_idsarrayThe IDs of teams that are pending to be connected to the channel. pending_sharedarrayThe list of pending shared items of the channel. previous_namesarrayThe previous names of the channel. purposeobjectThe purpose of the channel. shared_team_idsarrayThe IDs of teams with which the channel is shared. topicobjectThe topic of the channel. unlinkedintegerIndicates if the channel is unlinked. updatedintegerThe timestamp when the channel was last updated.
Response Schema Field Name Type Description dataarrayList of matching records metaobjectPagination metadata meta.has_morebooleanWhether additional pages are available meta.cursorstring | nullCursor for next page of results meta.took_msnumber | nullQuery execution time in milliseconds data[].context_team_idstringThe unique identifier of the team context in which the channel exists. data[].createdintegerThe timestamp when the channel was created. data[].creatorstringThe ID of the user who created the channel. data[].idstringThe unique identifier of the channel. data[].is_archivedbooleanIndicates if the channel is archived. data[].is_channelbooleanIndicates if the entity is a channel. data[].is_ext_sharedbooleanIndicates if the channel is externally shared. data[].is_generalbooleanIndicates if the channel is a general channel in the workspace. data[].is_groupbooleanIndicates if the channel is a group (private channel) rather than a regular channel. data[].is_imbooleanIndicates if the entity is a direct message (IM) channel. data[].is_memberbooleanIndicates if the calling user is a member of the channel. data[].is_mpimbooleanIndicates if the entity is a multiple person direct message (MPIM) channel. data[].is_org_sharedbooleanIndicates if the channel is organization-wide shared. data[].is_pending_ext_sharedbooleanIndicates if the channel is pending external shared. data[].is_privatebooleanIndicates if the channel is a private channel. data[].is_read_onlybooleanIndicates if the channel is read-only. data[].is_sharedbooleanIndicates if the channel is shared. data[].last_readstringThe timestamp of the user's last read message in the channel. data[].localestringThe locale of the channel. data[].namestringThe name of the channel. data[].name_normalizedstringThe normalized name of the channel. data[].num_membersintegerThe number of members in the channel. data[].parent_conversationstringThe parent conversation of the channel. data[].pending_connected_team_idsarrayThe IDs of teams that are pending to be connected to the channel. data[].pending_sharedarrayThe list of pending shared items of the channel. data[].previous_namesarrayThe previous names of the channel. data[].purposeobjectThe purpose of the channel. data[].shared_team_idsarrayThe IDs of teams with which the channel is shared. data[].topicobjectThe topic of the channel. data[].unlinkedintegerIndicates if the channel is unlinked. data[].updatedintegerThe timestamp when the channel was last updated.
Channel Messages
Channel Messages List
Returns messages from a channel
Python SDK
await slack . channel_messages . list ( channel = "<str>" )
API
curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {your_auth_token}' \ --data '{ "entity": "channel_messages", "action": "list", "params": { "channel": "<str>" } }'
Parameters
Parameter Name Type Required Description channelstringYes Channel ID to get messages from cursorstringNo Pagination cursor for next page limitintegerNo Number of messages to return per page oldeststringNo Start of time range (Unix timestamp) lateststringNo End of time range (Unix timestamp) inclusivebooleanNo Include messages with oldest or latest timestamps
Response Schema Records Field Name Type Description typestring | nullsubtypestring | nulltsstringuserstring | nulltextstring | nullthread_tsstring | nullreply_countinteger | nullreply_users_countinteger | nulllatest_replystring | nullreply_usersarray | nullis_lockedboolean | nullsubscribedboolean | nullreactionsarray | nullreactions[].namestring | nullreactions[].usersarray | nullreactions[].countinteger | nullattachmentsarray | nullattachments[].idinteger | nullattachments[].fallbackstring | nullattachments[].colorstring | nullattachments[].pretextstring | nullattachments[].author_namestring | nullattachments[].author_linkstring | nullattachments[].author_iconstring | nullattachments[].titlestring | nullattachments[].title_linkstring | nullattachments[].textstring | nullattachments[].fieldsarray | nullattachments[].image_urlstring | nullattachments[].thumb_urlstring | nullattachments[].footerstring | nullattachments[].footer_iconstring | nullattachments[].tsstring | integer | nullblocksarray | nullfilesarray | nullfiles[].idstring | nullfiles[].namestring | nullfiles[].titlestring | nullfiles[].mimetypestring | nullfiles[].filetypestring | nullfiles[].pretty_typestring | nullfiles[].userstring | nullfiles[].sizeinteger | nullfiles[].modestring | nullfiles[].is_externalboolean | nullfiles[].external_typestring | nullfiles[].is_publicboolean | nullfiles[].public_url_sharedboolean | nullfiles[].url_privatestring | nullfiles[].url_private_downloadstring | nullfiles[].permalinkstring | nullfiles[].permalink_publicstring | nullfiles[].createdinteger | nullfiles[].timestampinteger | nulleditedobject | anybot_idstring | nullbot_profileobject | anyapp_idstring | nullteamstring | null
Field Name Type Description next_cursorstring | nullhas_moreboolean | null
Channel Messages Search
Search and filter channel messages records powered by Airbyte's data sync. This often provides additional fields and operators beyond what the API natively supports, making it easier to narrow down results before performing further operations. Only available in hosted mode.
Python SDK
await slack . channel_messages . search ( query = { "filter" : { "eq" : { "type" : "<str>" } } } )
API
curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {your_auth_token}' \ --data '{ "entity": "channel_messages", "action": "search", "params": { "query": {"filter": {"eq": {"type": "<str>"}}} } }'
Parameters
Parameter Name Type Required Description queryobjectYes Filter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, like, fuzzy, keyword, not, and, or query.filterobjectNo Filter conditions query.sortarrayNo Sort conditions limitintegerNo Maximum results to return (default 1000) cursorstringNo Pagination cursor from previous response's meta.cursor fieldsarrayNo Field paths to include in results
Searchable Fields
Field Name Type Description typestringMessage type. subtypestringMessage subtype. tsstringMessage timestamp (unique identifier). userstringUser ID who sent the message. textstringMessage text content. thread_tsstringThread parent timestamp. reply_countintegerNumber of replies in thread. reply_users_countintegerNumber of unique users who replied. latest_replystringTimestamp of latest reply. reply_usersarrayUser IDs who replied to the thread. is_lockedbooleanWhether the thread is locked. subscribedbooleanWhether the user is subscribed to the thread. reactionsarrayReactions to the message. attachmentsarrayMessage attachments. blocksarrayBlock kit blocks. bot_idstringBot ID if message was sent by a bot. bot_profileobjectBot profile information. teamstringTeam ID.
Response Schema Field Name Type Description dataarrayList of matching records metaobjectPagination metadata meta.has_morebooleanWhether additional pages are available meta.cursorstring | nullCursor for next page of results meta.took_msnumber | nullQuery execution time in milliseconds data[].typestringMessage type. data[].subtypestringMessage subtype. data[].tsstringMessage timestamp (unique identifier). data[].userstringUser ID who sent the message. data[].textstringMessage text content. data[].thread_tsstringThread parent timestamp. data[].reply_countintegerNumber of replies in thread. data[].reply_users_countintegerNumber of unique users who replied. data[].latest_replystringTimestamp of latest reply. data[].reply_usersarrayUser IDs who replied to the thread. data[].is_lockedbooleanWhether the thread is locked. data[].subscribedbooleanWhether the user is subscribed to the thread. data[].reactionsarrayReactions to the message. data[].attachmentsarrayMessage attachments. data[].blocksarrayBlock kit blocks. data[].bot_idstringBot ID if message was sent by a bot. data[].bot_profileobjectBot profile information. data[].teamstringTeam ID.
Threads
Threads List
Returns messages in a thread (thread replies from conversations.replies endpoint)
Python SDK
await slack . threads . list ( channel = "<str>" )
API
curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {your_auth_token}' \ --data '{ "entity": "threads", "action": "list", "params": { "channel": "<str>" } }'
Parameters
Parameter Name Type Required Description channelstringYes Channel ID containing the thread tsstringNo Timestamp of the parent message (required for thread replies) cursorstringNo Pagination cursor for next page limitintegerNo Number of replies to return per page oldeststringNo Start of time range (Unix timestamp) lateststringNo End of time range (Unix timestamp) inclusivebooleanNo Include messages with oldest or latest timestamps
Response Schema Records Field Name Type Description typestring | nullsubtypestring | nulltsstringuserstring | nulltextstring | nullthread_tsstring | nullparent_user_idstring | nullreply_countinteger | nullreply_users_countinteger | nulllatest_replystring | nullreply_usersarray | nullis_lockedboolean | nullsubscribedboolean | nullreactionsarray | nullreactions[].namestring | nullreactions[].usersarray | nullreactions[].countinteger | nullattachmentsarray | nullattachments[].idinteger | nullattachments[].fallbackstring | nullattachments[].colorstring | nullattachments[].pretextstring | nullattachments[].author_namestring | nullattachments[].author_linkstring | nullattachments[].author_iconstring | nullattachments[].titlestring | nullattachments[].title_linkstring | nullattachments[].textstring | nullattachments[].fieldsarray | nullattachments[].image_urlstring | nullattachments[].thumb_urlstring | nullattachments[].footerstring | nullattachments[].footer_iconstring | nullattachments[].tsstring | integer | nullblocksarray | nullfilesarray | nullfiles[].idstring | nullfiles[].namestring | nullfiles[].titlestring | nullfiles[].mimetypestring | nullfiles[].filetypestring | nullfiles[].pretty_typestring | nullfiles[].userstring | nullfiles[].sizeinteger | nullfiles[].modestring | nullfiles[].is_externalboolean | nullfiles[].external_typestring | nullfiles[].is_publicboolean | nullfiles[].public_url_sharedboolean | nullfiles[].url_privatestring | nullfiles[].url_private_downloadstring | nullfiles[].permalinkstring | nullfiles[].permalink_publicstring | nullfiles[].createdinteger | nullfiles[].timestampinteger | nulleditedobject | anybot_idstring | nullbot_profileobject | anyapp_idstring | nullteamstring | null
Field Name Type Description next_cursorstring | nullhas_moreboolean | null
Threads Search
Search and filter threads records powered by Airbyte's data sync. This often provides additional fields and operators beyond what the API natively supports, making it easier to narrow down results before performing further operations. Only available in hosted mode.
Python SDK
await slack . threads . search ( query = { "filter" : { "eq" : { "type" : "<str>" } } } )
API
curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {your_auth_token}' \ --data '{ "entity": "threads", "action": "search", "params": { "query": {"filter": {"eq": {"type": "<str>"}}} } }'
Parameters
Parameter Name Type Required Description queryobjectYes Filter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, like, fuzzy, keyword, not, and, or query.filterobjectNo Filter conditions query.sortarrayNo Sort conditions limitintegerNo Maximum results to return (default 1000) cursorstringNo Pagination cursor from previous response's meta.cursor fieldsarrayNo Field paths to include in results
Searchable Fields
Field Name Type Description typestringMessage type. subtypestringMessage subtype. tsstringMessage timestamp (unique identifier). userstringUser ID who sent the message. textstringMessage text content. thread_tsstringThread parent timestamp. parent_user_idstringUser ID of the parent message author (present in thread replies). reply_countintegerNumber of replies in thread. reply_users_countintegerNumber of unique users who replied. latest_replystringTimestamp of latest reply. reply_usersarrayUser IDs who replied to the thread. is_lockedbooleanWhether the thread is locked. subscribedbooleanWhether the user is subscribed to the thread. blocksarrayBlock kit blocks. bot_idstringBot ID if message was sent by a bot. teamstringTeam ID.
Response Schema Field Name Type Description dataarrayList of matching records metaobjectPagination metadata meta.has_morebooleanWhether additional pages are available meta.cursorstring | nullCursor for next page of results meta.took_msnumber | nullQuery execution time in milliseconds data[].typestringMessage type. data[].subtypestringMessage subtype. data[].tsstringMessage timestamp (unique identifier). data[].userstringUser ID who sent the message. data[].textstringMessage text content. data[].thread_tsstringThread parent timestamp. data[].parent_user_idstringUser ID of the parent message author (present in thread replies). data[].reply_countintegerNumber of replies in thread. data[].reply_users_countintegerNumber of unique users who replied. data[].latest_replystringTimestamp of latest reply. data[].reply_usersarrayUser IDs who replied to the thread. data[].is_lockedbooleanWhether the thread is locked. data[].subscribedbooleanWhether the user is subscribed to the thread. data[].blocksarrayBlock kit blocks. data[].bot_idstringBot ID if message was sent by a bot. data[].teamstringTeam ID.
Messages
Messages Create
Posts a message to a public channel, private channel, or direct message conversation
Python SDK
await slack . messages . create ( channel = "<str>" , text = "<str>" , thread_ts = "<str>" , reply_broadcast = True , unfurl_links = True , unfurl_media = True )
API
curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {your_auth_token}' \ --data '{ "entity": "messages", "action": "create", "params": { "channel": "<str>", "text": "<str>", "thread_ts": "<str>", "reply_broadcast": True, "unfurl_links": True, "unfurl_media": True } }'
Parameters
Parameter Name Type Required Description channelstringYes Channel ID, private group ID, or user ID to send message to textstringYes Message text content (supports mrkdwn formatting) thread_tsstringNo Thread timestamp to reply to (for threaded messages) reply_broadcastbooleanNo Also post reply to channel when replying to a thread unfurl_linksbooleanNo Enable unfurling of primarily text-based content unfurl_mediabooleanNo Enable unfurling of media content
Response Schema Records Field Name Type Description typestring | nullsubtypestring | nulltextstring | nulltsstringuserstring | nullbot_idstring | nullapp_idstring | nullteamstring | nullbot_profileobject | any
Messages Update
Updates an existing message in a channel
Python SDK
await slack . messages . update ( channel = "<str>" , ts = "<str>" , text = "<str>" )
API
curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {your_auth_token}' \ --data '{ "entity": "messages", "action": "update", "params": { "channel": "<str>", "ts": "<str>", "text": "<str>" } }'
Parameters
Parameter Name Type Required Description channelstringYes Channel ID containing the message tsstringYes Timestamp of the message to update textstringYes New message text content
Response Schema Records Field Name Type Description typestring | nullsubtypestring | nulltextstring | nulltsstringuserstring | nullbot_idstring | nullapp_idstring | nullteamstring | nullbot_profileobject | any
Channel Topics
Channel Topics Create
Sets the topic for a channel
Python SDK
await slack . channel_topics . create ( channel = "<str>" , topic = "<str>" )
API
curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {your_auth_token}' \ --data '{ "entity": "channel_topics", "action": "create", "params": { "channel": "<str>", "topic": "<str>" } }'
Parameters
Parameter Name Type Required Description channelstringYes Channel ID to set topic for topicstringYes New topic text (max 250 characters)
Response Schema Records Field Name Type Description idstringnamestring | nullis_channelboolean | nullis_groupboolean | nullis_imboolean | nullis_mpimboolean | nullis_privateboolean | nullcreatedinteger | nullis_archivedboolean | nullis_generalboolean | nullunlinkedinteger | nullname_normalizedstring | nullis_sharedboolean | nullis_org_sharedboolean | nullis_pending_ext_sharedboolean | nullpending_sharedarray | nullcontext_team_idstring | nullupdatedinteger | nullcreatorstring | nullis_ext_sharedboolean | nullshared_team_idsarray | nullpending_connected_team_idsarray | nullis_memberboolean | nulltopicobject | anypurposeobject | anyprevious_namesarray | nullnum_membersinteger | nullparent_conversationstring | nullpropertiesobject | nullis_thread_onlyboolean | nullis_read_onlyboolean | null
Channel Purposes
Channel Purposes Create
Sets the purpose for a channel
Python SDK
await slack . channel_purposes . create ( channel = "<str>" , purpose = "<str>" )
API
curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {your_auth_token}' \ --data '{ "entity": "channel_purposes", "action": "create", "params": { "channel": "<str>", "purpose": "<str>" } }'
Parameters
Parameter Name Type Required Description channelstringYes Channel ID to set purpose for purposestringYes New purpose text (max 250 characters)
Response Schema Records Field Name Type Description idstringnamestring | nullis_channelboolean | nullis_groupboolean | nullis_imboolean | nullis_mpimboolean | nullis_privateboolean | nullcreatedinteger | nullis_archivedboolean | nullis_generalboolean | nullunlinkedinteger | nullname_normalizedstring | nullis_sharedboolean | nullis_org_sharedboolean | nullis_pending_ext_sharedboolean | nullpending_sharedarray | nullcontext_team_idstring | nullupdatedinteger | nullcreatorstring | nullis_ext_sharedboolean | nullshared_team_idsarray | nullpending_connected_team_idsarray | nullis_memberboolean | nulltopicobject | anypurposeobject | anyprevious_namesarray | nullnum_membersinteger | nullparent_conversationstring | nullpropertiesobject | nullis_thread_onlyboolean | nullis_read_onlyboolean | null
Reactions
Reactions Create
Adds a reaction (emoji) to a message
Python SDK
await slack . reactions . create ( channel = "<str>" , timestamp = "<str>" , name = "<str>" )
API
curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {your_auth_token}' \ --data '{ "entity": "reactions", "action": "create", "params": { "channel": "<str>", "timestamp": "<str>", "name": "<str>" } }'
Parameters
Parameter Name Type Required Description channelstringYes Channel ID containing the message timestampstringYes Timestamp of the message to react to namestringYes Reaction emoji name (without colons, e.g., "thumbsup")
Response Schema Records Field Name Type Description okboolean