v1

latestOpenAPI 3.0.02026-07-1417448450.4 KB
admin.conversations
admin

Search for public or private channels in an Enterprise organization.

get/admin.conversations.search

Query parameters

team_idsstring

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

querystring

Name of the the channel to query by.

limitinteger

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

cursorstring

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

search_channel_typesstring

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.

sortstring

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_dirstring

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)

Headers

tokenstring required

Authentication token. Requires scope: admin.conversations:read

Response

Typical success response

next_cursorstring required