Conversations

Admin Conversations Search

GET
/admin.conversations.search

Search for public or private channels in an Enterprise organization.

Authorization

slackAuth admin.conversations:read
AuthorizationBearer <token>

In: header

Scope: admin.conversations:read

Query Parameters

team_ids?string

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

query?string

Name of the the channel to query by.

limit?integer

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

Formatint32
cursor?string

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

search_channel_types?string

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

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

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 Parameters

token*string

Authentication token. Requires scope: admin.conversations:read

Content-Type*"application/x-www-form-urlencoded"

Value in

  • "application/x-www-form-urlencoded"

Response Body

application/json

application/json

curl -X GET "https://example.com/admin.conversations.search" \  -H "token: string" \  -H "Content-Type: application/x-www-form-urlencoded"
{  "channels": [    {      "accepted_user": "string",      "created": 0,      "creator": "string",      "id": "string",      "is_archived": true,      "is_channel": true,      "is_frozen": true,      "is_general": true,      "is_member": true,      "is_moved": 0,      "is_mpim": true,      "is_non_threadable": true,      "is_org_shared": true,      "is_pending_ext_shared": true,      "is_private": true,      "is_read_only": true,      "is_shared": true,      "is_thread_only": true,      "last_read": "string",      "latest": null,      "members": [],      "name": "string",      "name_normalized": "string",      "num_members": 0,      "pending_shared": [],      "previous_names": [],      "priority": 0,      "purpose": {        "creator": "string",        "last_set": 0,        "value": "string"      },      "topic": {        "creator": "string",        "last_set": 0,        "value": "string"      },      "unlinked": 0,      "unread_count": 0,      "unread_count_display": 0    }  ],  "next_cursor": "string"}