{ "opencollection": "1.0.0", "info": { "name": "Slack Admin Access Conversations API", "version": "1.0" }, "items": [ { "info": { "name": "Conversations", "type": "folder" }, "items": [ { "info": { "name": "Slack Post Admin Conversations Archive", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin.conversations.archive", "headers": [ { "name": "token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Archive a public or private channel." }, { "info": { "name": "Slack Post Admin Conversations Converttoprivate", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin.conversations.convertToPrivate", "headers": [ { "name": "token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Convert a public channel to a private channel." }, { "info": { "name": "Slack Post Admin Conversations Create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin.conversations.create", "headers": [ { "name": "token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a public or private channel-based conversation." }, { "info": { "name": "Slack Post Admin Conversations Delete", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin.conversations.delete", "headers": [ { "name": "token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete a public or private channel." }, { "info": { "name": "Slack Post Admin Conversations Disconnectshared", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin.conversations.disconnectShared", "headers": [ { "name": "token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Disconnect a connected channel from one or more workspaces." }, { "info": { "name": "Slack Get Admin Conversations Ekm Listoriginalconnectedchannelinfo", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin.conversations.ekm.listOriginalConnectedChannelInfo", "params": [ { "name": "token", "value": "", "type": "query", "description": "Authentication token. Requires scope: `admin.conversations:read`" }, { "name": "channel_ids", "value": "", "type": "query", "description": "A comma-separated list of channels to filter to." }, { "name": "team_ids", "value": "", "type": "query", "description": "A comma-separated list of the workspaces to which the channels you would like returned belong." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return. Must be between 1 - 1000 both inclusive." }, { "name": "cursor", "value": "", "type": "query", "description": "Set `cursor` to `next_cursor` returned by the previous call to list items in the next page." } ] }, "docs": "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." }, { "info": { "name": "Slack Get Admin Conversations Getconversationprefs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin.conversations.getConversationPrefs", "headers": [ { "name": "token", "value": "" } ], "params": [ { "name": "channel_id", "value": "", "type": "query", "description": "The channel to get preferences for." } ] }, "docs": "Get conversation preferences for a public or private channel." }, { "info": { "name": "Slack Get Admin Conversations Getteams", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin.conversations.getTeams", "headers": [ { "name": "token", "value": "" } ], "params": [ { "name": "channel_id", "value": "", "type": "query", "description": "The channel to determine connected workspaces within the organization for." }, { "name": "cursor", "value": "", "type": "query", "description": "Set `cursor` to `next_cursor` returned by the previous call to list items in the next page" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return. Must be between 1 - 1000 both inclusive." } ] }, "docs": "Get all the workspaces a given public or private channel is connected to within this Enterprise org." }, { "info": { "name": "Slack Post Admin Conversations Invite", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin.conversations.invite", "headers": [ { "name": "token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Invite a user to a public or private channel." }, { "info": { "name": "Slack Post Admin Conversations Rename", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin.conversations.rename", "headers": [ { "name": "token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Rename a public or private channel." }, { "info": { "name": "Slack Post Admin Conversations Restrictaccess Addgroup", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin.conversations.restrictAccess.addGroup", "body": { "type": "form-urlencoded", "data": [ { "name": "token", "value": "" }, { "name": "team_id", "value": "" }, { "name": "group_id", "value": "" }, { "name": "channel_id", "value": "" } ] } }, "docs": "Add an allowlist of IDP groups for accessing a channel" }, { "info": { "name": "Slack Get Admin Conversations Restrictaccess Listgroups", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin.conversations.restrictAccess.listGroups", "params": [ { "name": "token", "value": "", "type": "query", "description": "Authentication token. Requires scope: `admin.conversations:read`" }, { "name": "channel_id", "value": "", "type": "query" }, { "name": "team_id", "value": "", "type": "query", "description": "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." } ] }, "docs": "List all IDP Groups linked to a channel" }, { "info": { "name": "Slack Post Admin Conversations Restrictaccess Removegroup", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin.conversations.restrictAccess.removeGroup", "body": { "type": "form-urlencoded", "data": [ { "name": "token", "value": "" }, { "name": "team_id", "value": "" }, { "name": "group_id", "value": "" }, { "name": "channel_id", "value": "" } ] } }, "docs": "Remove a linked IDP group linked from a private channel" }, { "info": { "name": "Slack Get Admin Conversations Search", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin.conversations.search", "headers": [ { "name": "token", "value": "" } ], "params": [ { "name": "team_ids", "value": "", "type": "query", "description": "Comma separated string of team IDs, signifying the workspaces to search through." }, { "name": "query", "value": "", "type": "query", "description": "Name of the the channel to query by." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of items to be returned. Must be between 1 - 20 both inclusive. Default is 10." }, { "name": "cursor", "value": "", "type": "query", "description": "Set `cursor` to `next_cursor` returned by the previous call to list items in the next page." }, { "name": "search_channel_types", "value": "", "type": "query", "description": "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](#types)." }, { "name": "sort", "value": "", "type": "query", "description": "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 " }, { "name": "sort_dir", "value": "", "type": "query", "description": "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)" } ] }, "docs": "Search for public or private channels in an Enterprise organization." }, { "info": { "name": "Slack Post Admin Conversations Setconversationprefs", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin.conversations.setConversationPrefs", "headers": [ { "name": "token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Set the posting permissions for a public or private channel." }, { "info": { "name": "Slack Post Admin Conversations Setteams", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin.conversations.setTeams", "headers": [ { "name": "token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Set the workspaces in an Enterprise grid org that connect to a public or private channel." }, { "info": { "name": "Slack Post Admin Conversations Unarchive", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin.conversations.unarchive", "headers": [ { "name": "token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Unarchive a public or private channel." }, { "info": { "name": "Slack Post Conversations Archive", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/conversations.archive", "headers": [ { "name": "token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Archives a conversation." }, { "info": { "name": "Slack Post Conversations Close", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/conversations.close", "headers": [ { "name": "token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Closes a direct message or multi-person direct message." }, { "info": { "name": "Slack Post Conversations Create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/conversations.create", "headers": [ { "name": "token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Initiates a public or private channel-based conversation" }, { "info": { "name": "Slack Get Conversations History", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/conversations.history", "params": [ { "name": "token", "value": "", "type": "query", "description": "Authentication token. Requires scope: `conversations:history`" }, { "name": "channel", "value": "", "type": "query", "description": "Conversation ID to fetch history for." }, { "name": "latest", "value": "", "type": "query", "description": "End of time range of messages to include in results." }, { "name": "oldest", "value": "", "type": "query", "description": "Start of time range of messages to include in results." }, { "name": "inclusive", "value": "", "type": "query", "description": "Include messages with latest or oldest timestamp in results only when either timestamp is specified." }, { "name": "limit", "value": "", "type": "query", "description": "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." }, { "name": "cursor", "value": "", "type": "query", "description": "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](/docs/pagination) for more detail." } ] }, "docs": "Fetches a conversation's history of messages and events." }, { "info": { "name": "Slack Get Conversations Info", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/conversations.info", "params": [ { "name": "token", "value": "", "type": "query", "description": "Authentication token. Requires scope: `conversations:read`" }, { "name": "channel", "value": "", "type": "query", "description": "Conversation ID to learn more about" }, { "name": "include_locale", "value": "", "type": "query", "description": "Set this to `true` to receive the locale for this conversation. Defaults to `false`" }, { "name": "include_num_members", "value": "", "type": "query", "description": "Set to `true` to include the member count for the specified conversation. Defaults to `false`" } ] }, "docs": "Retrieve information about a conversation." }, { "info": { "name": "Slack Post Conversations Invite", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/conversations.invite", "headers": [ { "name": "token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Invites users to a channel." }, { "info": { "name": "Slack Post Conversations Join", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/conversations.join", "headers": [ { "name": "token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Joins an existing conversation." }, { "info": { "name": "Slack Post Conversations Kick", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/conversations.kick", "headers": [ { "name": "token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Removes a user from a conversation." }, { "info": { "name": "Slack Post Conversations Leave", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/conversations.leave", "headers": [ { "name": "token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Leaves a conversation." }, { "info": { "name": "Slack Get Conversations List", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/conversations.list", "params": [ { "name": "token", "value": "", "type": "query", "description": "Authentication token. Requires scope: `conversations:read`" }, { "name": "exclude_archived", "value": "", "type": "query", "description": "Set to `true` to exclude archived channels from the list" }, { "name": "types", "value": "", "type": "query", "description": "Mix and match channel types by providing a comma-separated list of any combination of `public_channel`, `private_channel`, `mpim`, `im`" }, { "name": "limit", "value": "", "type": "query", "description": "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." }, { "name": "cursor", "value": "", "type": "query", "description": "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](/docs/pagination) for more detail." } ] }, "docs": "Lists all channels in a Slack team." }, { "info": { "name": "Slack Post Conversations Mark", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/conversations.mark", "headers": [ { "name": "token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Sets the read cursor in a channel." }, { "info": { "name": "Slack Get Conversations Members", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/conversations.members", "params": [ { "name": "token", "value": "", "type": "query", "description": "Authentication token. Requires scope: `conversations:read`" }, { "name": "channel", "value": "", "type": "query", "description": "ID of the conversation to retrieve members for" }, { "name": "limit", "value": "", "type": "query", "description": "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." }, { "name": "cursor", "value": "", "type": "query", "description": "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](/docs/pagination) for more detail." } ] }, "docs": "Retrieve members of a conversation." }, { "info": { "name": "Slack Post Conversations Open", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/conversations.open", "headers": [ { "name": "token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Opens or resumes a direct message or multi-person direct message." }, { "info": { "name": "Slack Post Conversations Rename", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/conversations.rename", "headers": [ { "name": "token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Renames a conversation." }, { "info": { "name": "Slack Get Conversations Replies", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/conversations.replies", "params": [ { "name": "token", "value": "", "type": "query", "description": "Authentication token. Requires scope: `conversations:history`" }, { "name": "channel", "value": "", "type": "query", "description": "Conversation ID to fetch thread from." }, { "name": "ts", "value": "", "type": "query", "description": "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." }, { "name": "latest", "value": "", "type": "query", "description": "End of time range of messages to include in results." }, { "name": "oldest", "value": "", "type": "query", "description": "Start of time range of messages to include in results." }, { "name": "inclusive", "value": "", "type": "query", "description": "Include messages with latest or oldest timestamp in results only when either timestamp is specified." }, { "name": "limit", "value": "", "type": "query", "description": "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." }, { "name": "cursor", "value": "", "type": "query", "description": "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](/docs/pagination) for more detail." } ] }, "docs": "Retrieve a thread of messages posted to a conversation" }, { "info": { "name": "Slack Post Conversations Setpurpose", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/conversations.setPurpose", "headers": [ { "name": "token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Sets the purpose for a conversation." }, { "info": { "name": "Slack Post Conversations Settopic", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/conversations.setTopic", "headers": [ { "name": "token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Sets the topic for a conversation." }, { "info": { "name": "Slack Post Conversations Unarchive", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/conversations.unarchive", "headers": [ { "name": "token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Reverses conversation archival." }, { "info": { "name": "Slack Get Users Conversations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/users.conversations", "params": [ { "name": "token", "value": "", "type": "query", "description": "Authentication token. Requires scope: `conversations:read`" }, { "name": "user", "value": "", "type": "query", "description": "Browse conversations by a specific user ID's membership. Non-public channels are restricted to those where the calling user shares membership." }, { "name": "types", "value": "", "type": "query", "description": "Mix and match channel types by providing a comma-separated list of any combination of `public_channel`, `private_channel`, `mpim`, `im`" }, { "name": "exclude_archived", "value": "", "type": "query", "description": "Set to `true` to exclude archived channels from the list" }, { "name": "limit", "value": "", "type": "query", "description": "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." }, { "name": "cursor", "value": "", "type": "query", "description": "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](/docs/pagination) for more detail." } ] }, "docs": "List conversations the calling user may access." } ] } ], "bundled": true }