/admin.conversations.search

{ "channels": [ { "created": 1449252889, "creator": "U012A3CDE", "id": "C012AB3CD", "is_archived": false, "is_channel": true, "is_ext_shared": false, "is_general": true, "is_group": false, "is_im": false, "is_member": true, "is_mpim": false, "is_org_shared": false, "is_pending_ext_shared": false, "is_private": false, "is_shared": false, "name": "general", "name_normalized": "general", "num_members": 4, "pending_shared": [], "previous_names": [], "purpose": { "creator": "", "last_set": 0, "value": "This channel is for team-wide communication and announcements. All team members are in this channel." }, "topic": { "creator": "", "last_set": 0, "value": "Company-wide announcements and work-based matters" }, "unlinked": 0 } ], "ok": true, "response_metadata": { "next_cursor": "dGVhbTpDMDYxRkE1UEI=" } }

Request

Query Params

team_ids

string

optional

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

query

string

optional

Name of the the channel to query by.

limit

integer

optional

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

cursor

string

optional

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

search_channel_types

string

optional

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.

sort

string

optional

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_dir

string

optional

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)

Header Params

token

string

required

Authentication token. Requires scope: admin.conversations:read

Responses

🟢200Typical success response

application/json

Body

Schema for successful response of admin.conversations.search

channels

array[object (Channel Object) {32}]

required

accepted_user

string

optional

Match pattern:

^[UW][A-Z0-9]{2,}$

created

integer

required

creator

string

required

Match pattern:

^[UW][A-Z0-9]{2,}$

string

required

Match pattern:

^[C][A-Z0-9]{2,}$

is_archived

boolean

optional

is_channel

boolean

required

is_frozen

boolean

optional

is_general

boolean

optional

is_member

boolean

optional

is_moved

integer

optional

is_mpim

boolean

required

is_non_threadable

boolean

optional

is_org_shared

boolean

required

is_pending_ext_shared

boolean

optional

is_private

boolean

required

is_read_only

boolean

optional

is_shared

boolean

required

is_thread_only

boolean

optional

last_read

string

optional

Match pattern:

^\d{10}\.\d{6}$

latest

array [anyOf]

optional

members

array[string]

required

>= 0 items

name

string

required

name_normalized

string

required

num_members

integer

optional

pending_shared

array[string]

optional

>= 0 items

previous_names

array[string]

optional

>= 0 items

priority

number

optional

purpose

object

required

topic

object

required

unlinked

integer

Field to determine whether a channel has ever been shared/disconnected in the past

optional

unread_count

integer

optional

unread_count_display

integer

optional

next_cursor

string

required

🔴500Typical error response