admin_conversations_search

GET /admin.conversations.search

Copy endpoint

https://slack.com/api

Search for public or private channels in an Enterprise organization.

Parameters

query Query Parameters

Name	Type
`team_ids` Comma separated string of team IDs, signifying the workspaces to search through.	string
`query` Name of the the channel to query by.	string
`limit` Maximum number of items to be returned. Must be between 1 - 20 both inclusive. Default is 10.	number
`cursor` Set `cursor` to `next_cursor` returned by the previous call to list items in the next page.	string
`search_channel_types` 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.	string
`sort` 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` 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

header Header Parameters

Name	Type
`token` required Authentication token. Requires scope: `admin.conversations:read`	string

Responses

200 application/json

Typical success response

{ channels:

ObjsChannel

interface ObjsChannel {
accepted_user?: DefsUserId;
created: number;
creator: DefsUserId;
id: DefsChannelId;
is_archived?: boolean;
is_channel: boolean;
is_frozen?: boolean;
is_general?: boolean;
is_member?: boolean;
is_moved?: number;
is_mpim: boolean;
is_non_threadable?: boolean;
is_org_shared: boolean;
is_pending_ext_shared?: boolean;
is_private: boolean;
is_read_only?: boolean;
is_shared: boolean;
is_thread_only?: boolean;
last_read?: DefsTs;
latest?: (ObjsMessage | null)[];
members: DefsUserId[];
name: string;
name_normalized: string;
num_members?: number;
pending_shared?: DefsTeam[];
previous_names?: DefsChannelName[];
priority?: number;
purpose: { creator: DefsTopicPurposeCreator;last_set: number;value: string; };
topic: { creator: DefsTopicPurposeCreator;last_set: number;value: string; };
unlinked?: number;
unread_count?: number;
unread_count_display?: number;
}

[];next_cursor: string; }

default application/json

Typical error response

{ error: "feature_not_enabled" | "not_an_admin" | "not_an_enterprise" | "team_not_found" | "not_allowed" | "invalid_auth" | "invalid_cursor" | "invalid_search_channel_type" | "invalid_sort" | "invalid_sort_dir";ok:

DefsOkFalse

type DefsOkFalse = false

; }