provider admin.conversationsadmin GET /admin.conversations.search
@utdk/slack /admin.conversations.search
admin_conversations_search
Search for public or private channels in an Enterprise organization.
token header required
Authentication token. Requires scope: `admin.conversations:read`
string
team_ids query
Comma separated string of team IDs, signifying the workspaces to search through.
string
query query
Name of the the channel to query by.
string
limit query
Maximum number of items to be returned. Must be between 1 - 20 both inclusive. Default is 10.
integer
cursor query
Set `cursor` to `next_cursor` returned by the previous call to list items in the next page.
string
search_channel_types query
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).
string
sort query
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
string
sort_dir query
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)
string

Try it

Authentication
Configure credentials for Slack Web API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

adminConversationsSearch
GET/admin.conversations.search
Search for public or private channels in an Enterprise organization.

Comma separated string of team IDs, signifying the workspaces to search through.

Name of the the channel to query by.

Maximum number of items to be returned. Must be between 1 - 20 both inclusive. Default is 10.

Set `cursor` to `next_cursor` returned by the previous call to list items in the next page.

The type of channel to include or exclude in the search. For example `private` will search private channels, while `private_exclude` will exclude them. For a full list of types, check the [Types section](#types).

Possible values are `relevant` (search ranking based on what we think is closest), `name` (alphabetical), `member_count` (number of users in the channel), and `created` (date channel was created). You can optionally pair this with the `sort_dir` arg to change how it is sorted

Sort direction. Possible values are `asc` for ascending order like (1, 2, 3) or (a, b, c), and `desc` for descending order like (3, 2, 1) or (c, b, a)

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import slack from '@utdk/slack';

await slack.adminConversationsSearch()